Event(3pm)

📦
version 0.79 · 3 versions
, in ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Net::IRC::Event — event data goes ✨back and forth✨ between your subs

okay bestie, this is the Net::IRC::Event page from the Net::IRC manual set (section 3pm, the Perl module pages) — literally a whole class whose only job is carrying event data between your subroutines. it's giving "glorified envelope" and honestly? iconic.

📛 NAME

Net::IRC::Event — a class for passing event data between subroutines.

✨ SYNOPSIS

no synopsis yet. the docs are literally under construction, bestie. we're all just vibing here.

🦋 DESCRIPTION

so quick heads up: this documentation is a subset of the main Net::IRC documentation. if you haven't already, please run perldoc Net::IRC before you keep scrolling. fr fr. 💅

Net::IRC::Event defines a standard interface to the salient information for basically any event your client might witness on IRC. it's about as close as we can get in Perl to a struct, but with a few extra nifty features thrown in. like a struct but with main character energy. ✨

🎀 METHOD DESCRIPTIONS

this section is under construction too 😭 but hopefully it'll finally be written up by the next release. in the meantime, please look at the irctest script and the source for details about this module. iykyk.

🌸 LIST OF EVENTS

Net::IRC is an entirely event-based system, which takes some getting used to at first. to interact with the IRC server, you tell Net::IRC's server connection to listen for certain events and to activate your own subroutines when they occur. problem is... that doesn't help you much if you don't know what to tell it to look for. 🙈

so below is a list of the possible events you can pass to Net::IRC, along with brief descriptions of each... hope this helps. 🫶

🌈 Common events

  • nick — the nick event is triggered when the client receives a NICK message, meaning that someone on a channel with the client has changed eir nickname.
  • quit — the quit event is triggered upon receipt of a QUIT message, which means that someone on a channel with the client has disconnected.
  • join — the join event is triggered upon receipt of a JOIN message, which means that someone has entered a channel that the client is on.
  • part — the part event is triggered upon receipt of a PART message, which means that someone has left a channel that the client is on.
  • mode — the mode event is triggered upon receipt of a MODE message, which means that someone on a channel with the client has changed the channel's parameters.
  • topic — the topic event is triggered upon receipt of a TOPIC message, which means that someone on a channel with the client has changed the channel's topic.
  • kick — the kick event is triggered upon receipt of a KICK message, which means that someone on a channel with the client (or possibly the client itself!) has been forcibly ejected. 💀
  • public — the public event is triggered upon receipt of a PRIVMSG message to an entire channel, which means that someone on a channel with the client has said something aloud.
  • msg — the msg event is triggered upon receipt of a PRIVMSG message which is addressed to one or more clients, which means that someone is sending the client a private message. (duh. :-)
  • notice — the notice event is triggered upon receipt of a NOTICE message, which means that someone has sent the client a public or private notice. (is that sufficiently vague?)
  • ping — the ping event is triggered upon receipt of a PING message, which means that the IRC server is querying the client to see if it's alive. don't confuse this with CTCP PINGs, explained later.
  • other — the other event is triggered upon receipt of any number of unclassifiable miscellaneous messages, but you're not likely to see it often.
  • invite — the invite event is triggered upon receipt of an INVITE message, which means that someone is permitting the client's entry into a +i channel.
  • kill — the kill event is triggered upon receipt of a KILL message, which means that an IRC operator has just booted your sorry arse offline. seeya! 👋
  • disconnect — the disconnect event is triggered when the client loses its connection to the IRC server it's talking to. don't confuse it with the leaving event. (see below.)
  • leaving — the leaving event is triggered just before the client deliberately closes a connection to an IRC server, in case you want to do anything special before you sign off.
  • umode — the umode event is triggered when the client changes its personal mode flags.
  • error — the error event is triggered when the IRC server complains to you about anything. sort of the evil twin to the other event, actually. 😈

🧚 CTCP Requests

  • cping — the cping event is triggered when the client receives a CTCP PING request from another user. see the irctest script for an example of how to properly respond to this common request.
  • cversion — the cversion event is triggered when the client receives a CTCP VERSION request from another client, asking for version info about its IRC client program.
  • csource — the csource event is triggered when the client receives a CTCP SOURCE request from another client, asking where it can find the source to its IRC client program.
  • ctime — the ctime event is triggered when the client receives a CTCP TIME request from another client, asking for the local time at its end.
  • cdcc — the cdcc event is triggered when the client receives a DCC request of any sort from another client, attempting to establish a DCC connection.
  • cuserinfo — the cuserinfo event is triggered when the client receives a CTCP USERINFO request from another client, asking for personal information from the client's user.
  • cclientinfo — the cclientinfo event is triggered when the client receives a CTCP CLIENTINFO request from another client, asking for whatever the hell clientinfo means.
  • cerrmsg — the cerrmsg event is triggered when the client receives a CTCP ERRMSG request from another client, notifying it of a protocol error in a preceding CTCP communication.
  • cfinger — the cfinger event is triggered when the client receives a CTCP FINGER request from another client. how to respond to this should best be left up to your own moral stance. 🫣
  • caction — the caction event is triggered when the client receives a CTCP ACTION message from another client. i should hope you're getting the hang of how Net::IRC handles CTCP requests by now...

💜 CTCP Responses

  • crping — the crping event is triggered when the client receives a CTCP PING response from another user. see the irctest script for an example of how to properly respond to this common event.
  • crversion — the crversion event is triggered when the client receives a CTCP VERSION response from another client.
  • crsource — the crsource event is triggered when the client receives a CTCP SOURCE response from another client.
  • crtime — the crtime event is triggered when the client receives a CTCP TIME response from another client.
  • cruserinfo — the cruserinfo event is triggered when the client receives a CTCP USERINFO response from another client.
  • crclientinfo — the crclientinfo event is triggered when the client receives a CTCP CLIENTINFO response from another client.
  • crfinger — the crfinger event is triggered when the client receives a CTCP FINGER response from another client. i'm not even going to consider making a joke about this one. 😭

🍓 DCC Events

  • dcc_open — the dcc_open event is triggered when a DCC connection is established between the client and another client.
  • dcc_update — the dcc_update event is triggered when any data flows over a DCC connection. useful for doing things like monitoring file transfer progress, for instance.
  • dcc_close — the dcc_close event is triggered when a DCC connection closes, whether from an error or from natural causes.
  • chat — the chat event is triggered when the person on the other end of a DCC CHAT connection sends you a message. think of it as the private equivalent of msg, if you will.

⭐ Numeric Events

  • there's a whole lot of them, and they're well-described elsewhere. please see the IRC RFC (1495, at http://cs-ftp.bu.edu/pub/irc/support/IRC_RFC ) for a detailed description, or the Net::IRC::Event.pm source code for a quick list.

👑 AUTHORS

conceived and initially developed by Greg Bacon <gbacon@adtran.com> and Dennis Taylor <dennis@funkplanet.com>.

ideas and large amounts of code donated by Nat "King" Torkington <gnat@frii.com>.

currently being hacked on, hacked up, and worked over by the members of the Net::IRC developers mailing list. for details, see http://www.execpc.com/~corbeau/irc/list.html .

🌈 URL

up-to-date source and information about the Net::IRC project can be found at http://netirc.betterbox.net/ .

🫶 SEE ALSO

okay that's the whole page, no skips, no cuts, every single event accounted for 💅 this was built against perl v5.36.0 and dated 2022-10-15, so if you're reading this from the future... bestie, upgrade your perl. periodt. ✨🦋

📦 where this page comes from