GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EVENT::RPC::LOOP (3)

.ds Aq ’

NAME

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

CONTENTS

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-><B>enterB> () Enter resp. start a mainloop.
$loop-><B>leaveB> () Leave the mainloop, which was started with the enter() method.
$watcher = $loop-><B>add_io_watcherB> ( %options ) Add an I/O watcher. Options are passed as a hash of key/value pairs. The following options are known:
<B>fhB> The filehandle to be watched.
<B>cbB> This callback is called, without any parameters, if an event occured on the filehandle above.
<B>descB> A description of the watcher. Not necessarily implemented by all modules, so it may be ignored.
<B>pollB> 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-><B>del_io_watcherB> ( $watcher ) Deletes an I/O watcher which was added with $loop->add_io_watcher().
$timer = $loop-><B>add_timerB> ( %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:
<B>intervalB> A time interval in seconds, may be fractional.
<B>afterB> Callback is called once after this amount of seconds, may be fractional.
<B>cbB> The callback.
<B>descB> 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-><B>del_timerB> ( $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.

POD ERRORS

Hey! <B>The above document had some coding errors, which are explained below:B>
Around line 155: Non-ASCII character seen before =encoding in ’Joern’. Assuming ISO8859-1
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 EVENT::RPC::LOOP (3) 2009-04-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.