1Event::RPC::Connection(U3s)er Contributed Perl DocumentatEivoennt::RPC::Connection(3)
2
3
4

NAME

6       Event::RPC::Connection - Represents a RPC connection
7

SYNOPSIS

9       Note: you never create instances of this class in your own code, it's
10       only used internally by Event::RPC::Server. But you may request
11       connection objects using the connection_hook of Event::RPC::Server and
12       then having some read access on them.
13
14         my $connection = Event::RPC::Server::Connection->new (
15             $rpc_server, $client_socket
16         );
17
18       As well you can get the currently active connection from your
19       Event::RPC::Server object:
20
21         my $server     = Event::RPC::Server->instance;
22         my $connection = $server->get_active_connection;
23

DESCRIPTION

25       Objects of this class represents a connection from an
26       Event::RPC::Client to an Event::RPC::Server instance. They live inside
27       the server and the whole Client/Server protocol is implemented here.
28

READ ONLY ATTRIBUTES

30       The following attributes may be read using the corresponding
31       get_ATTRIBUTE accessors:
32
33       cid The connection ID of this connection. A number which is unique for
34           this server instance.
35
36       server
37           The Event::RPC::Server instance this connection belongs to.
38
39       is_authenticated
40           This boolean value reflects whether the connection is authenticated
41           resp. whether the client passed correct credentials.
42
43       auth_user
44           This is the name of the user who was authenticated successfully for
45           this connection.
46
47       client_oids
48           This is a hash reference of object id's which are in use by the
49           client of this connection. Keys are the object ids, value is always
50           1.  You can get the corresponding objects by using the
51
52             $connection->get_client_object($oid)
53
54           method.
55
56           Don't change anything in this hash, in particular don't delete or
57           add entries. Event::RPC does all the necessary garbage collection
58           transparently, no need to mess with that.
59

AUTHORS

61         Jörn Reder <joern AT zyn.de>
62

64       Copyright (C) 2005-2015 by Jörn Reder <joern AT zyn.de>.
65
66       This library is free software; you can redistribute it and/or modify it
67       under the same terms as Perl itself.
68
69
70
71perl v5.38.0                      2023-07-20         Event::RPC::Connection(3)
Impressum