event::rpc::loop(3pm) [debian man page]

Event::RPC::Loop(3pm)					User Contributed Perl Documentation				     Event::RPC::Loop(3pm)

NAME

       Event::RPC::Loop - Mainloop Abstraction layer for Event::RPC

SYNOPSIS

	 use Event::RPC::Server;
	 use Event::RPC::Loop::Glib;

	 my $server = Event::RPC::Server->new (
	     ...
	     loop => Event::RPC::Loop::Glib->new(),
	     ...
	 );

	 $server->start;

DESCRIPTION

       This modules defines the interface of Event::RPC's mainloop abstraction layer. It's a virtual class all mainloop modules should inherit
       from.

INTERFACE

       The following methods need to be implemented:

       $loop->enter ()
	   Enter resp. start a mainloop.

       $loop->leave ()
	   Leave the mainloop, which was started with the enter() method.

       $watcher = $loop->add_io_watcher ( %options )
	   Add an I/O watcher. Options are passed as a hash of key/value pairs. The following options are known:

	   fh  The filehandle to be watched.

	   cb  This callback is called, without any parameters, if an event occured on the filehandle above.

	   desc
	       A description of the watcher. Not necessarily implemented by all modules, so it may be ignored.

	   poll
	       Either 'r', if your program reads from the filehandle, or 'w' if it writes to it.

	   A watcher object is returned. What this exactly is depends on the implementation, so you can't do anything useful with it besides
	   passing it back to del_io_watcher().

       $loop->del_io_watcher ( $watcher )
	   Deletes an I/O watcher which was added with $loop->add_io_watcher().

       $timer = $loop->add_timer ( %options )
	   This sets a timer, a subroutine called after a specific timeout or on a regularly basis with a fixed time interval.

	   Options are passed as a hash of key/value pairs. The following options are known:

	   interval
	       A time interval in seconds, may be fractional.

	   after
	       Callback is called once after this amount of seconds, may be fractional.

	   cb  The callback.

	   desc
	       A description of the timer. Not necessarily implemented by all modules, so it may be ignored.

	   A timer object is returned. What this exactly is depends on the implementation, so you can't do anything useful with it besides passing
	   it back to del_io_timer().

       $loop->del_timer ( $timer )
	   Deletes a timer which was added with $loop->add_timer().

DIRECT USAGE IN YOUR SERVER

       You may use the methods of Event::RPC::Loop by yourself if you like. This way your program keeps independent of the actual mainloop module
       in use, if the simplified interface of Event::RPC::Loop is sufficient for you.

       In your server program you access the actual mainloop object this way:

	 my $loop = Event::RPC::Server->instance->get_loop;

       Naturally nothing speaks against making your program to work only with a specific mainloop implementation, if you need its features. In
       that case you may use the corresponding API directly (e.g. of Event or Glib), no need to access it through Event::RPC::Loop.

AUTHORS

	 Joern Reder <joern at zyn dot de>

COPYRIGHT AND LICENSE

       Copyright (C) 2002-2006 by Joern Reder, All Rights Reserved.

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

perl v5.10.1							    2006-04-23						     Event::RPC::Loop(3pm)

Check Out this Related Man Page

Event::RPC::Connection(3pm)				User Contributed Perl Documentation			       Event::RPC::Connection(3pm)

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

	 Joern Reder <joern at zyn dot de>

COPYRIGHT AND LICENSE

       Copyright (C) 2002-2006 by Joern Reder, All Rights Reserved.

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

perl v5.10.1							    2008-10-25					       Event::RPC::Connection(3pm)

Linux and UNIX Man Pages

event::rpc::loop(3pm) [debian man page]

Check Out this Related Man Page