Tom Molesworth > Protocol-XMPP-0.005 > Protocol::XMPP::Base

Download:
Protocol-XMPP-0.005.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.005   Source  

NAME ^

Protocol::XMPP::Base - base class for Protocol::XMPP

VERSION ^

version 0.005

SYNOPSIS ^

DESCRIPTION ^

METHODS ^

new

Constructor. Stores all parameters on $self, including the top level stack item as parent.

debug

Helper method for displaying a debug message. Only displayed if the debug flag was passed to configure.

_ref_to_xml

Convert an arrayref to an XML fragment.

Input such as the following:

 [ 'iq', type => 'set', id => 'xyz', _content => [ [ 'session', _ns => 'xmpp-session' ] ] ]

would be converted to:

 <iq type=>'set' id=>'xyz'><session xmlns='...:xmpp-session'/></iq>

PROXY METHODS ^

The following methods are proxied to the Protocol::XMPP::Stream class via stream.

is_loggedin

Accessor for the loggedin state - will call the appropriate on_(login|logout) event when changing state.

write_xml

Write XML reference to stream.

write_text

Write XML reference to stream.

dispatch_event

Pass through an event (on_XXX handler).

stream

Returns the active Protocol::XMPP::Stream object.

next_id

Returns the next ID for to use in outgoing messages.

AUTHOR ^

Tom Molesworth <cpan@entitymodel.com>

LICENSE ^

Copyright Tom Molesworth 2010-2011. Licensed under the same terms as Perl itself.

syntax highlighting: