.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "POE::Component::IRC::Plugin::Connector 3pm"
.TH POE::Component::IRC::Plugin::Connector 3pm "2018-01-01" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::IRC::Plugin::Connector \- A PoCo\-IRC plugin that deals with the
messy business of staying connected to an IRC server
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use POE qw(Component::IRC Component::IRC::Plugin::Connector);
\&
\& my $irc = POE::Component::IRC\->spawn();
\&
\& POE::Session\->create(
\&     package_states => [
\&         main => [ qw(_start lag_o_meter) ],
\&     ],
\& );
\&
\& $poe_kernel\->run();
\&
\& sub _start {
\&     my ($kernel, $heap) = @_[KERNEL ,HEAP];
\&     $irc\->yield( register => \*(Aqall\*(Aq );
\&
\&     $heap\->{connector} = POE::Component::IRC::Plugin::Connector\->new();
\&
\&     $irc\->plugin_add( \*(AqConnector\*(Aq => $heap\->{connector} );
\&
\&     $irc\->yield ( connect => { Nick => \*(Aqtestbot\*(Aq, Server => \*(Aqsomeserver.com\*(Aq } );
\&
\&     $kernel\->delay( \*(Aqlag_o_meter\*(Aq => 60 );
\&     return;
\& }
\&
\& sub lag_o_meter {
\&     my ($kernel,$heap) = @_[KERNEL,HEAP];
\&     print \*(AqTime: \*(Aq . time() . \*(Aq Lag: \*(Aq . $heap\->{connector}\->lag() . "\en";
\&     $kernel\->delay( \*(Aqlag_o_meter\*(Aq => 60 );
\&     return;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::Connector is a POE::Component::IRC
plugin that deals with making sure that your \s-1IRC\s0 bot stays connected to the \s-1IRC\s0
network of your choice. It implements the general algorithm as demonstrated at
<http://poe.perl.org/?POE_Cookbook/IRC_Bot_Reconnecting>.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Takes two optional arguments:
.PP
\&\fB'delay'\fR, the frequency, in seconds, at which the plugin will ping the \s-1IRC\s0
server. Defaults to 300.
.PP
\&\fB'reconnect'\fR, the time in seconds, to wait before trying to reconnect to
the server. Defaults to 60.
.PP
\&\fB'servers'\fR, an array reference of \s-1IRC\s0 servers to consider. Each element should
be an array reference containing a server host and (optionally) a port number.
The plugin will cycle through this list of servers whenever it reconnects.
.PP
Returns a plugin object suitable for use in
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.ie n .SS """lag"""
.el .SS "\f(CWlag\fP"
.IX Subsection "lag"
Returns the current 'lag' in seconds between sending PINGs to the \s-1IRC\s0 server
and getting \s-1PONG\s0 responses. Probably not likely to be wholely accurate.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris \*(L"BinGOs\*(R" Williams <chris@bingosnet.co.uk>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Component::IRC
.PP
POE::Component::IRC::Plugin