.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "POE::Component::Client::Ident 3pm"
.TH POE::Component::Client::Ident 3pm "2007-10-31" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
POE::Component::Client::Ident \- A component that provides non\-blocking ident lookups to your sessions.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   use POE::Component::Client::Ident;
.Ve
.PP
.Vb 1
\&   my $poco_obj = POE::Component::Client::Ident\->spawn ( \(aqIdent\-Client\(aq );
.Ve
.PP
.Vb 1
\&   $kernel\->post ( \(aqIdent\-Client\(aq => query => Socket => $socket );
.Ve
.PP
.Vb 6
\&   $kernel\->post ( \(aqIdent\-Client\(aq => query => PeerAddr => \(aq10.0.0.1\(aq, 
\&                                              PeerPort => 2345,
\&                                              SockAddr => \(aq192.168.1.254\(aq,
\&                                              SockPort => 6669,
\&                                              BuggyIdentd => 1,
\&                                              TimeOut => 30 );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::Client::Ident is a \s-1POE\s0 component that provides non-blocking Ident lookup services to
other components and sessions. The Ident protocol is described in \s-1RFC\s0 1413 <http://www.faqs.org/rfcs/rfc1413.html>.
.PP
The component takes requests in the form of events, spawns POE::Component::Client::Ident::Agent sessions to 
perform the Ident queries and returns the appropriate responses to the requesting session.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "spawn" 4
.IX Item "spawn"
Takes one argument, a kernel alias to christen the new component with.
.Sp
Returns an object.
.SH "METHODS"
.IX Header "METHODS"
These methods are available on the poco object returned by \fIspawn()\fR.
.IP "session_id" 4
.IX Item "session_id"
Returns the component's session \s-1ID\s0.
.IP "shutdown" 4
.IX Item "shutdown"
Takes no arguments. Causes the component to terminate gracefully. Any pending Ident::Agent components that are
running will be closed without returning events.
.SH "INPUT"
.IX Header "INPUT"
The component accepts the following events:
.IP "query" 4
.IX Item "query"
Takes either the arguments: 
.Sp
.Vb 4
\&  "PeerAddr", the remote IP address where a TCP connection has originated; 
\&  "PeerPort", the port where the TCP has originated from;
\&  "SockAddr", the address of our end of the connection; 
\&  "SockPort", the port of our end of the connection;
.Ve
.Sp
\&\s-1OR:\s0 
.Sp
.Vb 3
\&  "Socket", the socket handle of the connection, the component will work out all 
\&  the details for you. If Socket is defined, it will override the settings of the 
\&  other arguments.
.Ve
.Sp
See the documentation for Ident-Agent for extra parameters you may pass.
.IP "shutdown" 4
.IX Item "shutdown"
Takes no arguments. Causes the component to terminate gracefully. Any pending Ident::Agent components that are
running will be closed without returning events.
.SH "OUTPUT"
.IX Header "OUTPUT"
The events you can expect to receive having submitted a 'query'.
.PP
All the events returned by the component have a hashref as \s-1ARG0\s0. This hashref contains the arguments that were passed to
the component. If a socket handle was passed, the hashref will contain the appropriate PeerAddr, PeerPort, SockAddr and Sock
Port.
.IP "ident_client_reply" 4
.IX Item "ident_client_reply"
Returned when the component receives a \s-1USERID\s0 response from the identd. \s-1ARG0\s0 is hashref, \s-1ARG1\s0 is the opsys field and \s-1ARG2\s0 is
the userid or something else depending on whether the opsys field is set to '\s-1OTHER\s0' ( Don't blame me, read the \s-1RFC\s0 ).
.IP "ident_client_error" 4
.IX Item "ident_client_error"
Returned when the component receives an \s-1ERROR\s0 response from the identd, there was some sort of communication error with the
remote host ( ie. no identd running ) or it had some other problem with making the connection to the other host. No matter.
\&\s-1ARG0\s0 is hashref, \s-1ARG1\s0 is the type of error.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chris Williams, <chris@bingosnet.co.uk<gt>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1RFC\s0 1413 <http://www.faqs.org/rfcs/rfc1413.html>
.PP
POE::Component::Client::Ident::Agent