GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  POE::COMPONENT::IRC::PLUGIN::CTCP (3)

.ds Aq ’

NAME

POE::Component::IRC::Plugin::CTCP - A PoCo-IRC plugin that auto-responds to CTCP requests

CONTENTS

SYNOPSIS



 use strict;
 use warnings;
 use POE qw(Component::IRC Component::IRC::Plugin::CTCP);

 my $nickname = Flibble . $$;
 my $ircname = Flibble the Sailor Bot;
 my $ircserver = irc.blahblahblah.irc;
 my $port = 6667;

 my $irc = POE::Component::IRC->spawn(
     nick => $nickname,
     server => $ircserver,
     port => $port,
     ircname => $ircname,
 ) or die "Oh noooo! $!";

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

 $poe_kernel->run();

 sub _start {
     # Create and load our CTCP plugin
     $irc->plugin_add( CTCP => POE::Component::IRC::Plugin::CTCP->new(
         version => $ircname,
         userinfo => $ircname,
     ));

     $irc->yield( register => all );
     $irc->yield( connect => { } );
     return:
 }



DESCRIPTION

POE::Component::IRC::Plugin::CTCP is a POE::Component::IRC plugin. It watches for irc_ctcp_version, irc_ctcp_userinfo, irc_ctcp_ping, irc_ctcp_time and irc_ctcp_source events and autoresponds on your behalf.

METHODS

CWnew

Takes a number of optional arguments:

<B>’versionB>, a string to send in response to irc_ctcp_version. Default is PoCo-IRC and version;

<B>’clientinfo’B>, a string to send in response to irc_ctcp_clientinfo. Default is <http://search.cpan.org/perldoc?POE::Component::IRC::Plugin::CTCP>.

<B>’userinfo’B>, a string to send in response to irc_ctcp_userinfo. Default is ’m33p’;

<B>’source’B>, a string to send in response to irc_ctcp_source. Default is <http://search.cpan.org/dist/POE-Component-IRC>.

<B>’eat’B>, by default the plugin uses PCI_EAT_CLIENT, set this to 0 to disable this behaviour;

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

CWeat

With no arguments, returns true or false on whether the plugin is eating CTCP events that it has dealt with. An argument will set eating to on or off appropriately, depending on whether the value is true or false.

AUTHOR

Chris ’BinGOs’ Williams

SEE ALSO

CTCP Specification <http://www.irchelp.org/irchelp/rfc/ctcpspec.html>.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 POE::COMPONENT::IRC::PLUGIN::CTCP (3) 2014-06-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.