.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Event::RPC::Connection 3pm"
.TH Event::RPC::Connection 3pm "2018-07-21" "perl v5.26.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"
Event::RPC::Connection \- Represents a RPC connection
.SH "SYNOPSIS"
.IX Header "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 \fBconnection_hook\fR of Event::RPC::Server
and then having some read access on them.
.PP
.Vb 3
\&  my $connection = Event::RPC::Server::Connection\->new (
\&      $rpc_server, $client_socket
\&  );
.Ve
.PP
As well you can get the currently active connection from your
Event::RPC::Server object:
.PP
.Vb 2
\&  my $server     = Event::RPC::Server\->instance;
\&  my $connection = $server\->get_active_connection;
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.SH "READ ONLY ATTRIBUTES"
.IX Header "READ ONLY ATTRIBUTES"
The following attributes may be read using the corresponding
get_ATTRIBUTE accessors:
.IP "\fBcid\fR" 4
.IX Item "cid"
The connection \s-1ID\s0 of this connection. A number which is unique
for this server instance.
.IP "\fBserver\fR" 4
.IX Item "server"
The Event::RPC::Server instance this connection belongs to.
.IP "\fBis_authenticated\fR" 4
.IX Item "is_authenticated"
This boolean value reflects whether the connection is authenticated
resp. whether the client passed correct credentials.
.IP "\fBauth_user\fR" 4
.IX Item "auth_user"
This is the name of the user who was authenticated successfully for
this connection.
.IP "\fBclient_oids\fR" 4
.IX Item "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
.Sp
.Vb 1
\&  $connection\->get_client_object($oid)
.Ve
.Sp
method.
.Sp
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.
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 1
\&  Jörn Reder <joern AT zyn.de>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005\-2015 by Jörn Reder <joern \s-1AT\s0 zyn.de>.
.PP
This library is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.