io::async::routine(3pm) [debian man page]

IO::Async::Routine(3pm) 				User Contributed Perl Documentation				   IO::Async::Routine(3pm)

NAME

       "IO::Async::Routine" - execute code in an independent sub-process

SYNOPSIS

	use IO::Async::Routine;
	use IO::Async::Channel;

	use IO::Async::Loop;
	my $loop = IO::Async::Loop->new;

	my $nums_ch = IO::Async::Channel->new;
	my $ret_ch  = IO::Async::Channel->new;

	my $routine = IO::Async::Routine->new(
	   channels_in	=> [ $nums_ch ],
	   channels_out => [ $ret_ch ],

	   code => sub {
	      my @nums = @{ $nums_ch->recv };
	      my $ret = 0; $ret += $_ for @nums;

	      # Can only send references
	      $ret_ch->send( $ret );
	   },

	   on_finish => sub {
	      say "The routine aborted early - $_[-1]";
	      $loop->stop;
	   },
	);

	$loop->add( $routine );

	$nums_ch->send( [ 10, 20, 30 ] );
	$ret_ch->recv(
	   on_recv => sub {
	      my ( $ch, $totalref ) = @_;
	      say "The total of 10, 20, 30 is: $$totalref";
	      $loop->stop;
	   }
	);

	$loop->run;

DESCRIPTION

       This subclass of IO::Async::Process contains a body of code and executes it in a sub-process, allowing it to act independently of the main
       program. Once set up, all communication with the code happens by values passed into or out of the Routine via IO::Async::Channel objects.

       Because the code running inside the Routine runs within its own process, it is isolated from the rest of the program, in terms of memory,
       CPU time, and other resources, and perhaps most importantly in terms of control flow. The code contained within the Routine is free to make
       blocking calls without stalling the rest of the program. This makes it useful for using existing code which has no option not to block
       within an "IO::Async"-based program.

       To create asynchronous wrappers of functions that return a value based only on their arguments, and do not generally maintain state within
       the process it may be more convenient to use an IO::Async::Function instead, which uses an "IO::Async::Routine" to contain the body of the
       function and manages the Channels itself.

PARAMETERS

       The following named parameters may be passed to "new" or "configure":

       channels_in => ARRAY of IO::Async::Channel
	       ARRAY reference of "IO::Async::Channel" objects to set up for passing values in to the Routine.

       channels_out => ARRAY of IO::Async::Channel
	       ARRAY reference of "IO::Async::Channel" objects to set up for passing values out of the Routine.

       code => CODE
	       CODE reference to the body of the Routine, to execute once the channels are set up.

METHODS

       This class provides no additional methods, other than those provided by IO::Async::Process.

AUTHOR

       Paul Evans <leonerd@leonerd.org.uk>

perl v5.14.2							    2012-10-24						   IO::Async::Routine(3pm)

Check Out this Related Man Page

IO::Async::Loop::Poll(3pm)				User Contributed Perl Documentation				IO::Async::Loop::Poll(3pm)

NAME

       "IO::Async::Loop::Poll" - use "IO::Async" with "poll(2)"

SYNOPSIS

       Normally an instance of this class would not be directly constructed by a program. It may however, be useful for runinng IO::Async with an
       existing program already using an "IO::Poll" object.

	use IO::Poll;
	use IO::Async::Loop::Poll;

	my $poll = IO::Poll->new;
	my $loop = IO::Async::Loop::Poll->new( poll => $poll );

	$loop->add( ... );

	while(1) {
	   my $timeout = ...
	   my $ret = $poll->poll( $timeout );
	   $loop->post_poll;
	}

DESCRIPTION

       This subclass of "IO::Async::Loop" uses an "IO::Poll" object to perform read-ready and write-ready tests.

       To integrate with existing code that uses an "IO::Poll", a "post_poll" can be called immediately after the "poll" method on the contained
       "IO::Poll" object. The appropriate mask bits are maintained on the "IO::Poll" object when notifiers are added or removed from the set, or
       when they change their "want_writeready" status. The "post_poll" method inspects the result bits and invokes the "on_read_ready" or
       "on_write_ready" methods on the notifiers.

CONSTRUCTOR

   $loop = IO::Async::Loop::Poll->new( %args )
       This function returns a new instance of a "IO::Async::Loop::Poll" object. It takes the following named arguments:

       "poll"  The "IO::Poll" object to use for notification. Optional; if a value is not given, a new "IO::Poll" object will be constructed.

METHODS

   $count = $loop->post_poll( $poll )
       This method checks the returned event list from a "IO::Poll::poll" call, and calls any of the notification methods or callbacks that are
       appropriate.  It returns the total number of callbacks that were invoked; that is, the total number of "on_read_ready" and "on_write_ready"
       callbacks for "watch_io", and "watch_time" event callbacks.

       $poll   Reference to the "IO::Poll" object

   $count = $loop->loop_once( $timeout )
       This method calls the "poll" method on the stored "IO::Poll" object, passing in the value of $timeout, and then runs the "post_poll" method
       on itself. It returns the total number of callbacks invoked by the "post_poll" method, or "undef" if the underlying "poll" method returned
       an error.

AUTHOR

       Paul Evans <leonerd@leonerd.org.uk>

perl v5.14.2							    2012-10-24						IO::Async::Loop::Poll(3pm)

Linux and UNIX Man Pages

io::async::routine(3pm) [debian man page]

Check Out this Related Man Page