.\" 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::FollowTail 3pm"
.TH POE::Component::IRC::Plugin::FollowTail 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::FollowTail \- A PoCo\-IRC plugin to follow the tail
of an ever\-growing file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use POE qw(Component::IRC Component::IRC::Plugin::FollowTail);
\&
\& my $nickname = \*(AqFlibble\*(Aq . $$;
\& my $ircname = \*(AqFlibble the Sailor Bot\*(Aq;
\& my $ircserver = \*(Aqirc.blahblahblah.irc\*(Aq;
\& my $filename = \*(Aq/some/such/file/here\*(Aq;
\& my @channels = ( \*(Aq#Blah\*(Aq, \*(Aq#Foo\*(Aq, \*(Aq#Bar\*(Aq );
\&
\& 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 irc_001 irc_tail_input irc_tail_error irc_tail_reset) ],
\&     ],
\& );
\&
\&  $poe_kernel\->run();
\&
\& sub _start {
\&     $irc\->plugin_add( \*(AqFollowTail\*(Aq => POE::Component::IRC::Plugin::FollowTail\->new(
\&         filename => $filename,
\&     ));
\&     $irc\->yield( register => \*(Aqall\*(Aq );
\&     $irc\->yield( connect => { } );
\&     return;
\& }
\&
\& sub irc_001 {
\&     $irc\->yield( join => $_ ) for @channels;
\&     return;
\& }
\&
\& sub irc_tail_input {
\&     my ($kernel, $sender, $filename, $input) = @_[KERNEL, SENDER, ARG0, ARG1];
\&     $kernel\->post( $sender, \*(Aqprivmsg\*(Aq, $_, "$filename: $input" ) for @channels;
\&     return;
\& }
\&
\& sub irc_tail_error {
\&     my ($kernel, $sender, $filename, $errnum, $errstring)
\&         = @_[KERNEL, SENDER, ARG0 .. ARG2];
\&     $kernel\->post( $sender, \*(Aqprivmsg\*(Aq, $_, "$filename: ERROR: $errnum $errstring" ) for @channels;
\&     $irc\->plugin_del( \*(AqFollowTail\*(Aq );
\&     return;
\& }
\&
\& sub irc_tail_reset {
\&     my ($kernel, $sender, $filename) = @_[KERNEL, SENDER, ARG0];
\&     $kernel\->post( $sender, \*(Aqprivmsg\*(Aq, $_, "$filename: RESET EVENT" ) for @channels;
\&     return;
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::IRC::Plugin::FollowTail is a POE::Component::IRC
plugin that uses POE::Wheel::FollowTail to follow
the end of an ever-growing file. It generates \f(CW\*(C`irc_tail_\*(C'\fR prefixed events for
each new record that is appended to its file.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
Takes two arguments:
.PP
\&\fB'filename'\fR, the name of the file to tail, mandatory;
.PP
\&\fB'filter'\fR, a POE::Filter object to pass to POE::Wheel::FollowTail, optional;
.PP
Returns a plugin object suitable for feeding to
POE::Component::IRC's \f(CW\*(C`plugin_add\*(C'\fR method.
.SH "OUTPUT EVENTS"
.IX Header "OUTPUT EVENTS"
The plugin generates the following additional
POE::Component::IRC events:
.ie n .SS """irc_tail_input"""
.el .SS "\f(CWirc_tail_input\fP"
.IX Subsection "irc_tail_input"
Emitted for every complete record read. \f(CW\*(C`ARG0\*(C'\fR will be the filename,
\&\f(CW\*(C`ARG1\*(C'\fR the record which was read.
.ie n .SS """irc_tail_error"""
.el .SS "\f(CWirc_tail_error\fP"
.IX Subsection "irc_tail_error"
Emitted whenever an error occurs. \f(CW\*(C`ARG0\*(C'\fR will be the filename, \f(CW\*(C`ARG1\*(C'\fR
and \f(CW\*(C`ARG2\*(C'\fR hold numeric and string values for $!, respectively.
.ie n .SS """irc_tail_reset"""
.el .SS "\f(CWirc_tail_reset\fP"
.IX Subsection "irc_tail_reset"
Emitted every time a file is reset. \f(CW\*(C`ARG0\*(C'\fR will be the filename.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris 'BinGOs' Williams
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Component::IRC
.PP
POE::Wheel::FollowTail