NAME

POE::Component::Jabber::Status

SYNOPSIS

PCJ::Status exports many useful constants for tracking the status of PCJ during it's operation.

DESCRIPTION

PCJ, through the StatusEvent, will spit out various statuses for just about every step practical during normal operation. This includes being engaged during the various Protocol specific portions that get loaded to handle the dialects PCJ supports.

EXPORTS

Below are the exported constants with a brief explanation of what it is signalling to the end developer:

PCJ_CONNECT

'connect' or 'reconnect' event has fired.

PCJ_CONNECTING

Connecting is now in process

PCJ_CONNECTED

Initial connection established

PCJ_STREAMSTART

A <stream:stream/> tag has been sent. The number of these events is variable depending on which Protocol is currently active (ie. XMPP will send upto three, while LEGACY will only send one).

PCJ_SSLNEGOTIATE

TLS/SSL negotiation has begun. This Status event only is fired from XMPP and JABBERD20_COMPONENT connections.

PCJ_SSLSUCCESS

TLS/SSL negotiation has successfully complete. Socket layer is now encrypted. This Status event only is fired from XMPP and JABBERD20_COMPONENT connections.

PCJ_AUTHNEGOTIATE

Whatever your authentication method (ie. iq:auth, SASL, <handshake/>, etc), it is in process when this status is received.

PCJ_AUTHSUCCESS

Authentication was successful.

PCJ_BINDNEGOTIATE

For XMPP connections: this indicates resource binding negotiation has begun.

For JABBERD20_COMPONENT connections: domain binding negotiation has begun.

This Status event will not fire for any but the above two connection types.

PCJ_BINDSUCCESS

For XMPP connections: this indicates resource binding negotiation was sucessful.

For JABBERD20_COMPONENT connections: domain binding negotiation was successful.

This Status event will not fire for any but the above two connection types.

PCJ_SESSIONNEGOTIATE

Only for XMPP: This indicates session binding (XMPP IM) negotiation has begun.

PCJ_SESSIONSUCCESS

Only for XMPP: This indicates session binding (XMPP IM) negotiation was successful.

PCJ_NODESENT

A Node has been placed, outbound, into the Wheel

PCJ_NODERECEIVED

A Node has been received.

PCJ_NODEQUEUED

An attempt to send a Node while there is no valid, initialized connection was caught. The Node has been queued. See PCJ event 'purge_queue' for details.

PCJ_RTS_START

A return_to_sender event has been fired for an outbound node.

PCJ_RTS_FINISH

A return_to_sender event has been fired for a matching inbound node.

PCJ_INIT_FINISHED

This event indicates that the connection is fully initialized and ready for use.

Watch for this event and begin packat transactions AFTER it has been fired.

PCJ_STREAMEND

A </stream:stream> Node has been sent. This indicates the end of the connection and is called upon 'shutdown' of PCJ after the Node has been flushed.

PCJ_SHUTDOWN_START

This indicates that 'shutdown' has been fired and is currently in progress of tearing down the connection.

PCJ_SHUTDOWN_FINISH

This indicates that 'shutdown' is complete.

NOTES

These Statuses should remain fairly constant, but like the note in PCJ::Error, these Status events are not written in stone. They are written in vim and are subject to change.

AUTHOR

(c) Copyright 2007 Nicholas Perez. Released under the GPL.