poe::component::irc::plugin::cycleempty(3pm) [debian man page]

POE::Component::IRC::Plugin::CycleEmpty(3pm)		User Contributed Perl Documentation	      POE::Component::IRC::Plugin::CycleEmpty(3pm)

NAME

       POE::Component::IRC::Plugin::CycleEmpty - A PoCo-IRC plugin which cycles channels if they become empty and opless.

SYNOPSIS

	use POE::Component::IRC::Plugin::CycleEmpty;

	$irc->plugin_add('CycleEmpty', POE::Component::IRC::Plugin::CycleEmpty->new());

DESCRIPTION

       POE::Component::IRC::Plugin::CycleEmpty is a POE::Component::IRC plugin. When a channel member quits, gets kicked, or parts, the plugin
       will cycle the channel if the IRC component is alone on that channel and is not a channel operator. If there was a topic or a key set on
       the channel, they will be restored upon rejoining.

       This is useful for regaining ops in small channels if the IRC network does not have ChanServ or IRCNet's +R channel mode.

       This plugin requires the IRC component to be POE::Component::IRC::State or a subclass thereof.

METHODS

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

   "is_cycling"
       One argument:

       A channel name

       Returns 1 if the plugin is currently cycling that channel, 0 otherwise.	Useful if need to ignore the fact that the Component just parted
       the channel in question.

AUTHOR

       Hinrik Oern Sigur`sson, hinrik.sig@gmail.com

perl v5.14.2							    2011-12-07			      POE::Component::IRC::Plugin::CycleEmpty(3pm)

POE::Component::IRC::Cookbook::BasicBot(3pm)		User Contributed Perl Documentation	      POE::Component::IRC::Cookbook::BasicBot(3pm)

NAME

       POE::Component::IRC::Cookbook::BasicBot - A basic IRC bot

SYNOPSIS

       This a very basic bot that connects to IRC, joins a few channels, and announces its arrival.

DESCRIPTION

       We start off quite simply:

	#!/usr/bin/env perl

	use strict;
	use warnings;

       Then we "use" the stuff we're going to...well, use. "::State" is a subclass which keeps track of state information related to channels and
       nicknames. It is needed by the "AutoJoin" plugin which takes care of keeping us on our channels.

	use POE;
	use POE::Component::IRC::State;
	use POE::Component::IRC::Plugin::AutoJoin;

       Next up is our POE session. We create it and list our event handlers. We then start the POE kernel.

	POE::Session->create(
	    package_states => [
		main => [ qw(_start irc_join) ]
	    ]
	);

	$poe_kernel->run();

       Now all we have to do is write the handlers for "_start" and "irc_join".  In "_start", we create our IRC component, add an "AutoJoin"
       plugin, register for the "irc_join" event, and connect to the IRC server.

	sub _start {
	    my $irc = POE::Component::IRC::State->spawn(
		Nick   => 'basic_bot',
		Server => 'irc.freenode.net',
	    );

	    $irc->plugin_add('AutoJoin', POE::Component::IRC::Plugin::AutoJoin->new(
	       Channels => [ '#test_channel1', '#test_channel2' ]
	    ));

	    $irc->yield(register => 'join');
	    $irc->yield('connect');
	}

       Now comes our "irc_join" event handler. We send a message to the channel once we've joined it.

	sub irc_join {
	    my $nick = (split /!/, $_[ARG0])[0];
	    my $channel = $_[ARG1];
	    my $irc = $_[SENDER]->get_heap();

	    # only send the message if we were the one joining
	    if ($nick eq $irc->nick_name()) {
		$irc->yield(privmsg => $channel, 'Hi everybody!');
	    }
	}

       That's it!

AUTHOR

       Hinrik Oern Sigur`sson, hinrik.sig@gmail.com

perl v5.14.2							    2011-12-07			      POE::Component::IRC::Cookbook::BasicBot(3pm)