.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.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
.\" ========================================================================
.\"
.IX Title "POE::Component::Client::Ident 3pm"
.TH POE::Component::Client::Ident 3pm "2022-12-04" "perl v5.36.0" "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::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;
\&
\&   my $poco_obj = POE::Component::Client::Ident\->spawn ( \*(AqIdent\-Client\*(Aq );
\&
\&   $kernel\->post ( \*(AqIdent\-Client\*(Aq => query => Socket => $socket );
\&
\&   $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 1413\s0 <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"
.ie n .IP """spawn""" 4
.el .IP "\f(CWspawn\fR" 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 \fBspawn()\fR.
.ie n .IP """session_id""" 4
.el .IP "\f(CWsession_id\fR" 4
.IX Item "session_id"
Returns the component's session \s-1ID.\s0
.ie n .IP """shutdown""" 4
.el .IP "\f(CWshutdown\fR" 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:
.ie n .IP """query""" 4
.el .IP "\f(CWquery\fR" 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.
.ie n .IP """shutdown""" 4
.el .IP "\f(CWshutdown\fR" 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.
.ie n .IP """ident_client_reply""" 4
.el .IP "\f(CWident_client_reply\fR" 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 ).
.ie n .IP """ident_client_error""" 4
.el .IP "\f(CWident_client_error\fR" 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 "LICENSE"
.IX Header "LICENSE"
Copyright © Chris Williams.
.PP
This module may be used, modified, and distributed under the same terms as Perl itself. Please see the license that came with your Perl distribution for details.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1RFC 1413\s0 <http://www.faqs.org/rfcs/rfc1413.html>
.PP
POE::Component::Client::Ident::Agent