.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Kanla::Plugin::Banner 3pm"
.TH Kanla::Plugin::Banner 3pm "2014-06-10" "perl v5.18.2" "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"
Kanla::Plugin::Banner \- Useful functions for banner\-based plugins
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Kanla::Plugin;
\&    use Kanla::Plugin::Banner;
\&
\&    sub run {
\&        banner_connect(
\&            host            => \*(Aqirc.twice\-irc.de\*(Aq,
\&            default_service => \*(Aqircd\*(Aq,
\&            cb              => sub {
\&                my ($handle, $timeout) = @_;
\&                $handle\->push_write("NICK kanla\er\en");
\&                $handle\->push_write("USER kanla kanla kanla :kanla\er\en");
\&                my @read_line;
\&                @read_line = (
\&                    line => sub {
\&                        my ($handle, $line) = @_;
\&                        if ($line !~ /^:[^ ]+ 001 /) {
\&                            $handle\->push_read(@read_line);
\&                            return;
\&                        }
\&
\&                        # We successfully signed on.
\&                        undef $timeout;
\&                        $handle\->push_write("QUIT\er\en");
\&                        banner_disconnect($handle);
\&                    });
\&
\&                $handle\->push_read(@read_line);
\&            });
\&    }
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "banner_connect"
.IX Subsection "banner_connect"
Connects to the given address
(parsed by \f(CW\*(C`AnyEvent::Socket\*(C'\fR's parse_hostport)
using the configured address families.
.PP
The caller provides a callback,
which will be called
after the connection was established.
In case there was an error
(\s-1DNS\s0 name could not be resolved,
connection was refused/timed out,
etc.),
the callback will \fB\s-1NOT\s0\fR be called,
but an alert will be signaled.
.PP
The callback will be called
with an \f(CW\*(C`AnyEvent::Handle\*(C'\fR and
an \f(CW\*(C`AnyEvent\*(C'\fR timer (timeouts).
.PP
The timeout is initialized
to the configured value
(plugin configuration)
or 20s if left unconfigured.
.PP
This example connects to one of
Google's \s-1SMTP\s0 servers
and waits for the \s-1SMTP\s0 greeting.
It does not resolve \s-1MX\s0 records,
but that's not the point of the example:
.PP
.Vb 10
\&    banner_connect(
\&        host => \*(Aqaspmx.l.google.com\*(Aq,
\&        default_service => \*(Aqsmtp\*(Aq,
\&        cb => sub {
\&            my ($handle, $timeout) = @_;
\&            $handle\->push_read(line => sub {
\&                my ($handle, $line) = @_;
\&                undef $timeout;
\&                if ($line !~ /^220 /) {
\&                    signal_error(\*(Aqcritical\*(Aq, \*(AqInvalid greeting\*(Aq);
\&                }
\&            });
\&        });
.Ve
.SS "banner_disconnect($handle)"
.IX Subsection "banner_disconnect($handle)"
Properly disconnects
the specified \f(CW\*(C`AnyEvent::Handle\*(C'\fR.