POE::C...Events(3pm)

💖 NAME 💖

okay so POE::Component::Jabber::Events — it's the little bestie that exports constants so you can track the status of PCJ. that's it. that's the whole job. she's a constants girlie. ✨

---

🎀 SYNOPSIS 🎀

like, here's every single one of them, in order, no skipping:

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

---

🌸 DESCRIPTION 🌸

so POE::Component::Jabber::Events exports a whole bunch of useful constants for tracking the status of PCJ while it's out there doing its thing. 🦋

the move is literally just: subscribe to these events and boom, you get notified. that's the vibe. periodt. 💅

---

✨ EXPORTS ✨

below are all the exported constants, each with a lil rundown of what it's actually signalling to you, the end developer 🫶:

• PCJ_CONNECT — the 'connect' or 'reconnect' event has fired. she's up. 🔥
• PCJ_CONNECTING — connecting is now in process. hold please, we're loading bestie ⏳
• PCJ_CONNECTED — initial connection established. we're in 💖
• PCJ_STREAMSTART — a <stream:stream/> tag has been sent. heads up: how many of these you get is variable, depending on which Protocol is currently active (like, XMPP will send upto three, while LEGACY will only send one). no cap. 🌈
• PCJ_SSLNEGOTIATE — TLS/SSL negotiation has begun. and listen: this event only is fired from XMPP and JABBERD20_COMPONENT connections. 🔐
• PCJ_SSLSUCCESS — TLS/SSL negotiation has successfully complete. socket layer is now encrypted. also: this event only is fired from XMPP and JABBERD20_COMPONENT connections. 🎉
• PCJ_SSLFAIL — TLS/SSL negotiation has failed. 😭 and yeah, this event only is fired from XMPP and JABBERD20_COMPONENT connections. 💀
• PCJ_AUTHNEGOTIATE — whatever your authentication method is (like iq:auth, SASL, <handshake/>, etc), it is in process when this status is received. it's giving "prove it" 💅
• PCJ_AUTHSUCCESS — authentication was successful. slay. ✨
• PCJ_AUTHFAIL — authentication failed. 🙈
• PCJ_BINDNEGOTIATE — two flavours, bestie:
  • For XMPP connections: this indicates resource binding negotiation has begun.
  • For JABBERD20_COMPONENT connections: domain binding negotiation has begun.
  • and fr fr: this event will not fire for any but the above two connection types.
• PCJ_BINDSUCCESS — again, two flavours:
  • For XMPP connections: this indicates resource binding negotiation was sucessful.
  • For JABBERD20_COMPONENT connections: domain binding negotiation was successful.
  • same deal: this event will not fire for any but the above two connection types.
• PCJ_BINDFAIL — binding for which ever context has failed. 😔
• 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_SESSIONFAIL — session negotiation has failed for which ever context. 💀
• PCJ_NODESENT — a Node has been placed, outbound, into the Wheel. ARG0 will be the node. 📤
• PCJ_NODERECEIVED — a Node has been received. ARG0 will be the node. 📥
• PCJ_NODEQUEUED — an attempt to send a Node while there is no valid, initialized connection was caught. the Node has been queued. peep the POE::Component::Jabber event 'purge_queue' for details. ARG0 will be the node. 🧺
• PCJ_RTS_START — a return_to_sender event has been fired for an outbound node. ARG0 will be the node. 🌀
• PCJ_RTS_FINISH — a return_to_sender event has been fired for a matching inbound node. ARG0 will be the node. 🎯
• 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. seriously, don't jump the gun bestie. ✋

• 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. bye bestie 👋
• PCJ_SOCKETFAIL — this indicates a socket level error. ARG0..ARG2 will be exactly what was passed to us from POE::Wheel::ReadWrite. 😵
• PCJ_SOCKETDISCONNECT — this indicates the socket has disconnected and will occur in both normal, and in error states. 🌊

---

👑 AUTHOR 👑

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

---

and that's the whole page, mwah 💋 this was perl v5.36.0, dated 2023-08-26, and it's the POE::C...Events(3pm) page from the User Contributed Perl Documentation. go forth and track those statuses, bestie 🎀✨🦋