/usr/share/perl5/POE/Component/Jabber/Events.pm is in libpoe-component-jabber-perl 3.00-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 | package POE::Component::Jabber::Events;
use warnings;
use strict;
use constant
{
'PCJ_CONNECT' => 'PCJ_CONNECT',
'PCJ_CONNECTING' => 'PCJ_CONNECTING',
'PCJ_CONNECTED' => 'PCJ_CONNECTED',
'PCJ_CONNECTFAIL' => 'PCJ_CONNECTFAIL',
'PCJ_STREAMSTART' => 'PCJ_STEAMSTART',
'PCJ_STREAMEND' => 'PCJ_STREAMEND',
'PCJ_NODESENT' => 'PCJ_NODESENT',
'PCJ_NODERECEIVED' => 'PCJ_NODERECEIVED',
'PCJ_NODEQUEUED' => 'PCJ_NODEQUEUED',
'PCJ_SSLNEGOTIATE' => 'PCJ_SSLNEGOTIATE',
'PCJ_SSLSUCCESS' => 'PCJ_SSLSUCCESS',
'PCJ_SSLFAIL' => 'PCJ_SSLFAIL',
'PCJ_AUTHNEGOTIATE' => 'PCJ_AUTHNEGOTIATE',
'PCJ_AUTHSUCCESS' => 'PCJ_AUTHSUCCESS',
'PCJ_AUTHFAIL' => 'PCJ_AUTHFAIL',
'PCJ_BINDNEGOTIATE' => 'PCJ_BINDNEGOTIATE',
'PCJ_BINDSUCCESS' => 'PCJ_BINDSUCCESS',
'PCJ_BINDFAIL' => 'PCJ_BINDFAIL',
'PCJ_SESSIONNEGOTIATE' => 'PCJ_SESSIONNEGOTIATE',
'PCJ_SESSIONSUCCESS' => 'PCJ_SESSIONSUCCESS',
'PCJ_SESSIONFAIL' => 'PCJ_SESSIONFAIL',
'PCJ_RTS_START' => 'PCJ_RTS_START',
'PCJ_RTS_FINISH' => 'PCJ_RTS_FINISH',
'PCJ_READY' => 'PCJ_READY',
'PCJ_SHUTDOWN_START' => 'PCJ_SHUTDOWN_START',
'PCJ_SHUTDOWN_FINISH' => 'PCJ_SHUTDOWN_FINISH',
'PCJ_SOCKETFAIL' => 'PCJ_SOCKETFAIL',
'PCJ_SOCKETDISCONNECT' => 'PCJ_SOCKETDISCONNECT',
};
use base('Exporter');
our @EXPORT = qw/ PCJ_CONNECT PCJ_CONNECTING PCJ_CONNECTED PCJ_STREAMSTART
PCJ_SSLNEGOTIATE PCJ_SSLSUCCESS PCJ_AUTHNEGOTIATE PCJ_AUTHSUCCESS
PCJ_BINDNEGOTIATE PCJ_BINDSUCCESS PCJ_SESSIONNEGOTIATE PCJ_SESSIONSUCCESS
PCJ_NODESENT PCJ_NODERECEIVED PCJ_NODEQUEUED PCJ_RTS_START
PCJ_RTS_FINISH PCJ_READY PCJ_STREAMEND PCJ_SHUTDOWN_START
PCJ_SHUTDOWN_FINISH PCJ_SOCKETFAIL PCJ_SOCKETDISCONNECT PCJ_AUTHFAIL
PCJ_BINDFAIL PCJ_SESSIONFAIL PCJ_SSLFAIL PCJ_CONNECTFAIL /;
our $VERSION = '3.00';
1;
__END__
=pod
=head1 NAME
POE::Component::Jabber::Events - exports constants for tracking status of PCJ
=head1 SYNOPSIS
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
=head1 DESCRIPTION
POE::Component::Jabber::Events exports many useful constants for tracking the
status of PCJ during its operation. Simply subscribe to these events in order
to receive notification.
=head1 EXPORTS
Below are the exported constants with a brief explanation of what it is
signalling to the end developer:
=over 4
=item PCJ_CONNECT
'connect' or 'reconnect' event has fired.
=item PCJ_CONNECTING
Connecting is now in process
=item PCJ_CONNECTED
Initial connection established
=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. XMPP will send upto three,
while LEGACY will only send one).
=item PCJ_SSLNEGOTIATE
TLS/SSL negotiation has begun.
This event only is fired from XMPP and JABBERD20_COMPONENT connections.
=item PCJ_SSLSUCCESS
TLS/SSL negotiation has successfully complete. Socket layer is now encrypted.
This event only is fired from XMPP and JABBERD20_COMPONENT connections.
=item PCJ_SSLFAIL
TLS/SSL negotiation has failed.
This event only is fired from XMPP and JABBERD20_COMPONENT connections.
=item PCJ_AUTHNEGOTIATE
Whatever your authentication method (ie. iq:auth, SASL, <handshake/>, etc), it
is in process when this status is received.
=item PCJ_AUTHSUCCESS
Authentication was successful.
=item PCJ_AUTHFAIL
Authentication failed.
=item PCJ_BINDNEGOTIATE
For XMPP connections: this indicates resource binding negotiation has begun.
For JABBERD20_COMPONENT connections: domain binding negotiation has begun.
This event will not fire for any but the above two connection types.
=item PCJ_BINDSUCCESS
For XMPP connections: this indicates resource binding negotiation was
sucessful.
For JABBERD20_COMPONENT connections: domain binding negotiation was successful.
This event will not fire for any but the above two connection types.
=item PCJ_BINDFAIL
Binding for which ever context has failed.
=item PCJ_SESSIONNEGOTIATE
Only for XMPP: This indicates session binding (XMPP IM) negotiation has begun.
=item PCJ_SESSIONSUCCESS
Only for XMPP: This indicates session binding (XMPP IM) negotiation was
successful.
=item PCJ_SESSIONFAIL
Session negotiation has failed for which ever context.
=item PCJ_NODESENT
A Node has been placed, outbound, into the Wheel. ARG0 will be the node.
=item PCJ_NODERECEIVED
A Node has been received. ARG0 will be the node.
=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. ARG0 will be the node.
=item PCJ_RTS_START
A return_to_sender event has been fired for an outbound node. ARG0 will be the
node.
=item PCJ_RTS_FINISH
A return_to_sender event has been fired for a matching inbound node. ARG0 will
be the node.
=item PCJ_READY
This event indicates that the connection is fully initialized and ready for use.
Watch for this event and begin packet transactions AFTER it has been fired.
=item 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.
=item PCJ_SHUTDOWN_START
This indicates that 'shutdown' has been fired and is currently in progress of
tearing down the connection.
=item PCJ_SHUTDOWN_FINISH
This indicates that 'shutdown' is complete.
=item PCJ_SOCKETFAIL
This indicates a socket level error. ARG0..ARG2 will be exactly what was passed
to us from POE::Wheel::ReadWrite.
=item PCJ_SOCKETDISCONNECT
This indicates the socket has disconnected and will occur in both normal, and
in error states.
=back
=head1 AUTHOR
(c) Copyright 2007-2009 Nicholas Perez. Released under the GPL.
=cut
|