Net::Async::IRC::Protocol - send and receive IRC messages
This subclass of IO::Async::Protocol::LineStream implements an established IRC connection that has already completed its inital login sequence and is ready to send and receive IRC messages. It handles base message sending and receiving, and implements ping timers.
Objects of this type would not normally be constructed directly. For IRC clients, see Net::Async::IRC which is a subclass of it. All the events, parameters, and methods documented below are relevant there.
Returns a new instance of a
This object represents a IRC connection to a peer.
As it is a subclass of
IO::Async::Protocol::LineStream its constructor takes any arguments for that class,
in addition to the parameters named below.
The following named parameters may be passed to
A CODE reference to the generic message handler; see
MESSAGE HANDLING below.
Any parameter whose name starts with
on_message_ can be installed as a handler for a specific message,
in preference to the generic handler.
Amount of quiet time,
after a message is received from the peer,
PING will be sent to check it is still alive.
after sending a
to wait for a
A CODE reference to invoke if the peer fails to respond to a
PING message within the given timeout.
$on_ping_timeout->( $irc )
A CODE reference to invoke when the peer successfully sends a
PONG in response of a
$on_pong_reply->( $irc, $lag )
$lag is the response time in (fractional) seconds.
If supplied, sets an encoding to use to encode outgoing messages and decode incoming messages.
Returns true if a connection to the peer is established. Note that even after a successful connection, the connection may not yet logged in to. See also the
Returns true if the full login sequence has been performed on the connection and it is ready to use.
Returns the current nick in use by the connection.
Returns the current nick in use by the connection, folded by
casefold_name for convenience.
A message with a command of
COMMAND will try handlers in following places:
$on_message_COMMAND->( $irc, $message, \%hints )
$irc->on_message_COMMAND( $message, \%hints )
$on_message->( $irc, 'COMMAND', $message, \%hints )
$irc->on_message( 'COMMAND', $message, \%hints )
Certain commands are handled internally by methods on the base
Net::Async::IRC::Protocol class itself. These may cause other hints hash keys to be created, or to invoke other handler methods. These are documented below.
Paul Evans <email@example.com>