.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "POE::Component::Client::Ident::Agent 3pm"
.TH POE::Component::Client::Ident::Agent 3pm "2016-08-21" "perl v5.22.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"
POE::Component::Client::Ident::Agent \- A component to provide a one\-shot non\-blocking Ident query.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use POE::Component::Client::Ident::Agent;
\&
\&  my $poco = POE::Component::Client::Ident::Agent\->spawn( 
\&                                                PeerAddr => "192.168.1.12", # Originating IP Address
\&                                                PeerPort => 12345,          # Originating port
\&                                                SockAddr => "192.168.2.24", # Local IP address
\&                                                SockPort => 69,             # Local Port
\&                                                Socket   => $socket_handle, # Or pass in a socket handle
\&                                                IdentPort => 113,           # Port to send queries to on originator
\&                                                                            # Default shown
\&                                                BuggyIdentd => 0,           # Dealing with an Identd that isn\*(Aqt
\&                                                                            # RFC compatable. Default is 0.
\&                                                TimeOut => 30,              # Adjust the timeout period.
\&                                                Reference => $scalar        # Give the component a reference
\&                                                );
\&
\&  sub _child {
\&   my ($action,$child,$reference) = @_[ARG0,ARG1,ARG2];
\&
\&   if ( $action eq \*(Aqcreate\*(Aq ) {
\&     # Stuff
\&   }
\&  }
\&
\&  sub ident_agent_reply {
\&  }
\&
\&  sub ident_agent_error {
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
POE::Component::Client::Ident::Agent is a \s-1POE\s0 component that provides a single \*(L"one shot\*(R" look up of a username
on the remote side of a \s-1TCP\s0 connection to other components and sessions, using the ident (auth/tap) protocol.
The Ident protocol is described in \s-1RFC 1413 \s0<http://www.faqs.org/rfcs/rfc1413.html>.
.PP
The component implements a single ident request. Your session spawns the component, passing the relevant arguments and at 
some future point will receive either a 'ident_agent_reply' or 'ident_agent_error', depending on the outcome of the query.
.PP
If you are looking for a robust method of managing Ident::Agent sessions then please consult the documentation for 
POE::Component::Client::Ident, which takes care of Agent management for you.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "spawn" 4
.IX Item "spawn"
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, 
\&  except for:
\&
\&  "IdentPort", which is the port on the remote host where we send our ident queries.
\&  This is optional, defaults to 113.
.Ve
.Sp
You may also specify BuggyIdentd to 1, to support Identd that doesn't terminate lines as per the \s-1RFC.\s0
.Sp
You may also specify TimeOut between 5 and 30, to have a shorter timeout in seconds on waiting for a response from the Identd. Default is 30 seconds.
.Sp
Optionally, you can specify Reference, which is anything that'll fit in a scalar. This will get passed back as part of the response. See below.
.Sp
Returns an POE::Component::Client::Ident::Agent object, which has the following methods.
.SH "METHODS"
.IX Header "METHODS"
.IP "session_id" 4
.IX Item "session_id"
Returns the \s-1POE\s0 session \s-1ID\s0 of the component.
.IP "shutdown" 4
.IX Item "shutdown"
Terminates the component.
.SH "OUTPUT"
.IX Header "OUTPUT"
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 SockPort. If the component was spawned with a Reference parameter, this will be passed back as a key of the hashref.
.PP
The following events are sent to the calling session by the component:
.IP "ident_agent_reply" 4
.IX Item "ident_agent_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_agent_error" 4
.IX Item "ident_agent_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 1413 \s0<http://www.faqs.org/rfcs/rfc1413.html>
.PP
POE::Session
.PP
POE::Component::Client::Ident