POE::Component::IRC::Plugin::ISupport.3pm

Langue: en

Version: 2008-02-18 (mandriva - 01/05/08)

Section: 3 (Bibliothèques de fonctions)

NAME

POE::Component::IRC::Plugin::ISupport - A PoCo-IRC plugin that handles server capabilities.

DESCRIPTION

This handles the "irc_005" messages that come from the server. They define the capabilities support by the server.

CONSTRUCTOR

"new"
Takes no arguments.

Returns a plugin object suitable for feeding to POE::Component::IRC's plugin_add() method.

METHODS

"isupport"
Takes one argument. the server capability to query. Returns a false value on failure or a value representing the applicable capability. A full list of capabilities is available at <http://www.irc.org/tech_docs/005.html>.
"isupport_dump_keys"
Takes no arguments, returns a list of the available server capabilities, which can be used with isupport().

Handlers

This module handles the following PoCo-IRC signals:

"irc_005" (RPL_ISUPPORT or RPL_PROTOCTL)
Denotes the capabilities of the server.
"all"
Once the next signal is received that is greater than "irc_005", it emits an "irc_isupport" signal.

Signals Emitted

"irc_isupport"
Emitted by: the first signal received after "irc_005"

ARG0 will be the plugin object itself for ease of use.

This is emitted when the support report has finished.

AUTHOR

Jeff "japhy" Pinyan, japhy@perlmonk.org

SEE ALSO

POE::Component::IRC

POE::Component::IRC::Plugin