POE::Component::Client::Ident(3pm)

1POE::Component::Client:U:sIedrenCto(n3t)ributed Perl DocPuOmEe:n:tCaotmipoonnent::Client::Ident(3)
2
3
4

NAME

6       POE::Component::Client::Ident - A component that provides non-blocking
7       ident lookups to your sessions.
8

SYNOPSIS

10          use POE::Component::Client::Ident;
11
12          my $poco_obj = POE::Component::Client::Ident->spawn ( 'Ident-Client' );
13
14          $kernel->post ( 'Ident-Client' => query => Socket => $socket );
15
16          $kernel->post ( 'Ident-Client' => query => PeerAddr => '10.0.0.1',
17                                                     PeerPort => 2345,
18                                                     SockAddr => '192.168.1.254',
19                                                     SockPort => 6669,
20                                                     BuggyIdentd => 1,
21                                                     TimeOut => 30 );
22

DESCRIPTION

24       POE::Component::Client::Ident is a POE component that provides non-
25       blocking Ident lookup services to other components and sessions. The
26       Ident protocol is described in RFC 1413
27       <http://www.faqs.org/rfcs/rfc1413.html>.
28
29       The component takes requests in the form of events, spawns
30       POE::Component::Client::Ident::Agent sessions to perform the Ident
31       queries and returns the appropriate responses to the requesting
32       session.
33

CONSTRUCTOR

35       "spawn"
36           Takes one argument, a kernel alias to christen the new component
37           with.
38
39           Returns an object.
40

METHODS

42       These methods are available on the poco object returned by spawn().
43
44       "session_id"
45           Returns the component's session ID.
46
47       "shutdown"
48           Takes no arguments. Causes the component to terminate gracefully.
49           Any pending Ident::Agent components that are running will be closed
50           without returning events.
51

INPUT

53       The component accepts the following events:
54
55       "query"
56           Takes either the arguments:
57
58             "PeerAddr", the remote IP address where a TCP connection has originated;
59             "PeerPort", the port where the TCP has originated from;
60             "SockAddr", the address of our end of the connection;
61             "SockPort", the port of our end of the connection;
62
63           OR:
64
65             "Socket", the socket handle of the connection, the component will work out all
66             the details for you. If Socket is defined, it will override the settings of the
67             other arguments.
68
69           See the documentation for Ident-Agent for extra parameters you may
70           pass.
71
72       "shutdown"
73           Takes no arguments. Causes the component to terminate gracefully.
74           Any pending Ident::Agent components that are running will be closed
75           without returning events.
76

OUTPUT

78       The events you can expect to receive having submitted a 'query'.
79
80       All the events returned by the component have a hashref as ARG0. This
81       hashref contains the arguments that were passed to the component. If a
82       socket handle was passed, the hashref will contain the appropriate
83       PeerAddr, PeerPort, SockAddr and Sock Port.
84
85       "ident_client_reply"
86           Returned when the component receives a USERID response from the
87           identd. ARG0 is hashref, ARG1 is the opsys field and ARG2 is the
88           userid or something else depending on whether the opsys field is
89           set to 'OTHER' ( Don't blame me, read the RFC ).
90
91       "ident_client_error"
92           Returned when the component receives an ERROR response from the
93           identd, there was some sort of communication error with the remote
94           host ( ie. no identd running ) or it had some other problem with
95           making the connection to the other host. No matter.  ARG0 is
96           hashref, ARG1 is the type of error.
97

AUTHOR

99       Chris Williams, <chris@bingosnet.co.uk<gt>
100

LICENSE

102       Copyright © Chris Williams.
103
104       This module may be used, modified, and distributed under the same terms
105       as Perl itself. Please see the license that came with your Perl
106       distribution for details.
107