.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POE::Component::Jabber::Events 3pm"
.TH POE::Component::Jabber::Events 3pm "2023-08-26" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::Jabber::Events \- exports constants for tracking status of PCJ
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 10
\&  PCJ_CONNECT
\&  PCJ_CONNECTING
\&  PCJ_CONNECTED
\&  PCJ_CONNECTFAIL
\&  PCJ_STREAMSTART
\&  PCJ_STREAMEND
\&  PCJ_NODESENT
\&  PCJ_NODERECEIVED
\&  PCJ_NODEQUEUED
\&  PCJ_SSLNEGOTIATE
\&  PCJ_SSLSUCCESS
\&  PCJ_SSLFAIL
\&  PCJ_AUTHNEGOTIATE
\&  PCJ_AUTHSUCCESS
\&  PCJ_AUTHFAIL
\&  PCJ_BINDNEGOTIATE
\&  PCJ_BINDSUCCESS
\&  PCJ_BINDFAIL
\&  PCJ_SESSIONNEGOTIATE
\&  PCJ_SESSIONSUCCESS
\&  PCJ_SESSIONFAIL
\&  PCJ_RTS_START
\&  PCJ_RTS_FINISH
\&  PCJ_READY
\&  PCJ_SHUTDOWN_START
\&  PCJ_SHUTDOWN_FINISH
\&  PCJ_SOCKETFAIL
\&  PCJ_SOCKETDISCONNECT
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::Jabber::Events exports many useful constants for tracking the 
status of \s-1PCJ\s0 during its operation. Simply subscribe to these events in order
to receive notification.
.SH "EXPORTS"
.IX Header "EXPORTS"
Below are the exported constants with a brief explanation of what it is 
signalling to the end developer:
.IP "\s-1PCJ_CONNECT\s0" 4
.IX Item "PCJ_CONNECT"
\&'connect' or 'reconnect' event has fired.
.IP "\s-1PCJ_CONNECTING\s0" 4
.IX Item "PCJ_CONNECTING"
Connecting is now in process
.IP "\s-1PCJ_CONNECTED\s0" 4
.IX Item "PCJ_CONNECTED"
Initial connection established
.IP "\s-1PCJ_STREAMSTART\s0" 4
.IX Item "PCJ_STREAMSTART"
A <stream:stream/> tag has been sent. The number of these events is variable 
depending on which Protocol is currently active (ie. \s-1XMPP\s0 will send upto three, 
while \s-1LEGACY\s0 will only send one).
.IP "\s-1PCJ_SSLNEGOTIATE\s0" 4
.IX Item "PCJ_SSLNEGOTIATE"
\&\s-1TLS/SSL\s0 negotiation has begun.
This event only is fired from \s-1XMPP\s0 and \s-1JABBERD20_COMPONENT\s0 connections.
.IP "\s-1PCJ_SSLSUCCESS\s0" 4
.IX Item "PCJ_SSLSUCCESS"
\&\s-1TLS/SSL\s0 negotiation has successfully complete. Socket layer is now encrypted. 
This event only is fired from \s-1XMPP\s0 and \s-1JABBERD20_COMPONENT\s0 connections.
.IP "\s-1PCJ_SSLFAIL\s0" 4
.IX Item "PCJ_SSLFAIL"
\&\s-1TLS/SSL\s0 negotiation has failed.
This event only is fired from \s-1XMPP\s0 and \s-1JABBERD20_COMPONENT\s0 connections.
.IP "\s-1PCJ_AUTHNEGOTIATE\s0" 4
.IX Item "PCJ_AUTHNEGOTIATE"
Whatever your authentication method (ie. iq:auth, \s-1SASL,\s0 <handshake/>, etc), it
is in process when this status is received.
.IP "\s-1PCJ_AUTHSUCCESS\s0" 4
.IX Item "PCJ_AUTHSUCCESS"
Authentication was successful.
.IP "\s-1PCJ_AUTHFAIL\s0" 4
.IX Item "PCJ_AUTHFAIL"
Authentication failed.
.IP "\s-1PCJ_BINDNEGOTIATE\s0" 4
.IX Item "PCJ_BINDNEGOTIATE"
For \s-1XMPP\s0 connections: this indicates resource binding negotiation has begun.
.Sp
For \s-1JABBERD20_COMPONENT\s0 connections: domain binding negotiation has begun.
.Sp
This event will not fire for any but the above two connection types.
.IP "\s-1PCJ_BINDSUCCESS\s0" 4
.IX Item "PCJ_BINDSUCCESS"
For \s-1XMPP\s0 connections: this indicates resource binding negotiation was 
sucessful.
.Sp
For \s-1JABBERD20_COMPONENT\s0 connections: domain binding negotiation was successful.
.Sp
This event will not fire for any but the above two connection types.
.IP "\s-1PCJ_BINDFAIL\s0" 4
.IX Item "PCJ_BINDFAIL"
Binding for which ever context has failed.
.IP "\s-1PCJ_SESSIONNEGOTIATE\s0" 4
.IX Item "PCJ_SESSIONNEGOTIATE"
Only for \s-1XMPP:\s0 This indicates session binding (\s-1XMPP IM\s0) negotiation has begun.
.IP "\s-1PCJ_SESSIONSUCCESS\s0" 4
.IX Item "PCJ_SESSIONSUCCESS"
Only for \s-1XMPP:\s0 This indicates session binding (\s-1XMPP IM\s0) negotiation was
successful.
.IP "\s-1PCJ_SESSIONFAIL\s0" 4
.IX Item "PCJ_SESSIONFAIL"
Session negotiation has failed for which ever context.
.IP "\s-1PCJ_NODESENT\s0" 4
.IX Item "PCJ_NODESENT"
A Node has been placed, outbound, into the Wheel. \s-1ARG0\s0 will be the node.
.IP "\s-1PCJ_NODERECEIVED\s0" 4
.IX Item "PCJ_NODERECEIVED"
A Node has been received. \s-1ARG0\s0 will be the node.
.IP "\s-1PCJ_NODEQUEUED\s0" 4
.IX Item "PCJ_NODEQUEUED"
An attempt to send a Node while there is no valid, initialized connection was 
caught. The Node has been queued. See POE::Component::Jabber event 
\&'purge_queue' for details. \s-1ARG0\s0 will be the node.
.IP "\s-1PCJ_RTS_START\s0" 4
.IX Item "PCJ_RTS_START"
A return_to_sender event has been fired for an outbound node. \s-1ARG0\s0 will be the
node.
.IP "\s-1PCJ_RTS_FINISH\s0" 4
.IX Item "PCJ_RTS_FINISH"
A return_to_sender event has been fired for a matching inbound node. \s-1ARG0\s0 will
be the node.
.IP "\s-1PCJ_READY\s0" 4
.IX Item "PCJ_READY"
This event indicates that the connection is fully initialized and ready for use.
.Sp
Watch for this event and begin packet transactions \s-1AFTER\s0 it has been fired.
.IP "\s-1PCJ_STREAMEND\s0" 4
.IX Item "PCJ_STREAMEND"
A </stream:stream> Node has been sent. This indicates the end of the connection
and is called upon 'shutdown' of \s-1PCJ\s0 after the Node has been flushed.
.IP "\s-1PCJ_SHUTDOWN_START\s0" 4
.IX Item "PCJ_SHUTDOWN_START"
This indicates that 'shutdown' has been fired and is currently in progress of 
tearing down the connection.
.IP "\s-1PCJ_SHUTDOWN_FINISH\s0" 4
.IX Item "PCJ_SHUTDOWN_FINISH"
This indicates that 'shutdown' is complete.
.IP "\s-1PCJ_SOCKETFAIL\s0" 4
.IX Item "PCJ_SOCKETFAIL"
This indicates a socket level error. \s-1ARG0..ARG2\s0 will be exactly what was passed
to us from POE::Wheel::ReadWrite.
.IP "\s-1PCJ_SOCKETDISCONNECT\s0" 4
.IX Item "PCJ_SOCKETDISCONNECT"
This indicates the socket has disconnected and will occur in both normal, and 
in error states.
.SH "AUTHOR"
.IX Header "AUTHOR"
(c) Copyright 2007\-2009 Nicholas Perez. Released under the \s-1GPL.\s0