oracular (3) Event::RPC::Connection.3pm.gz

NAME

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

SYNOPSIS

       Note: you never create instances of this class in your own code, it's only used internally by
       Event::RPC::Server. But you may request connection objects using the connection_hook of
       Event::RPC::Server and then having some read access on them.

         my $connection = Event::RPC::Server::Connection->new (
             $rpc_server, $client_socket
         );

       As well you can get the currently active connection from your Event::RPC::Server object:

         my $server     = Event::RPC::Server->instance;
         my $connection = $server->get_active_connection;

DESCRIPTION

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

READ ONLY ATTRIBUTES

       The following attributes may be read using the corresponding get_ATTRIBUTE accessors:

       cid The connection ID of this connection. A number which is unique for this server instance.

       server
           The Event::RPC::Server instance this connection belongs to.

       is_authenticated
           This boolean value reflects whether the connection is authenticated resp. whether the client passed
           correct credentials.

       auth_user
           This is the name of the user who was authenticated successfully for this connection.

       client_oids
           This is a hash reference of object id's which are in use by the client of this connection. Keys are
           the object ids, value is always 1.  You can get the corresponding objects by using the

             $connection->get_client_object($oid)

           method.

           Don't change anything in this hash, in particular don't delete or add entries. Event::RPC does all
           the necessary garbage collection transparently, no need to mess with that.

AUTHORS

         Jörn Reder <joern AT zyn.de>

COPYRIGHT AND LICENSE

       Copyright (C) 2005-2015 by Jörn Reder <joern AT zyn.de>.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl
       itself.