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

IO::Async::Protocol::Stream(3pm)			User Contributed Perl Documentation			  IO::Async::Protocol::Stream(3pm)

NAME

       "IO::Async::Protocol::Stream" - base class for stream-based protocols

SYNOPSIS

       Most likely this class will be subclassed to implement a particular network protocol.

	package Net::Async::HelloWorld;

	use strict;
	use warnings;
	use base qw( IO::Async::Protocol::Stream );

	sub on_read
	{
	   my $self = shift;
	   my ( $buffref, $eof ) = @_;

	   return 0 unless $$buffref =~ s/^(.*)
//;
	   my $line = $1;

	   if( $line =~ m/^HELLO (.*)/ ) {
	      my $name = $1;

	      $self->invoke_event( on_hello => $name );
	   }

	   return 1;
	}

	sub send_hello
	{
	   my $self = shift;
	   my ( $name ) = @_;

	   $self->write( "HELLO $name
" );
	}

       This small example elides such details as error handling, which a real protocol implementation would be likely to contain.

DESCRIPTION

       This subclass of IO::Async::Protocol is intended to stand as a base class for implementing stream-based protocols. It provides an interface
       similar to IO::Async::Stream, primarily, a "write" method and an "on_read" event handler.

       It contains an instance of an "IO::Async::Stream" object which it uses for actual communication, rather than being a subclass of it,
       allowing a level of independence from the actual stream being used. For example, the stream may actually be an IO::Async::SSLStream to
       allow the protocol to be used over SSL.

       As with "IO::Async::Stream", it is required that by the time the protocol object is added to a Loop, that it either has an "on_read"
       method, or has been configured with an "on_read" callback handler.

EVENTS

       The following events are invoked, either using subclass methods or CODE references in parameters:

   $ret = on_read $buffer, $eof
       The "on_read" handler is invoked identically to "IO::Async::Stream".

   on_closed
       The "on_closed" handler is optional, but if provided, will be invoked after the stream is closed by either side (either because the
       "close()" method has been invoked on it, or on an incoming EOF).

PARAMETERS

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

       on_read => CODE
	       CODE reference for the "on_read" event.

       handle => IO
	       A shortcut for the common case where the transport only needs to be a plain "IO::Async::Stream" object. If this argument is
	       provided without a "transport" object, a new "IO::Async::Stream" object will be built around the given IO handle, and used as the
	       transport.

METHODS

   $protocol->write( $data )
       Writes the given data by calling the "write" method on the contained transport stream.

   $protocol->connect( %args )
       Sets up a connection to a peer, and configures the underlying "transport" for the Protocol. Calls "IO::Async::Protocol" "connect" with
       "socktype" set to "stream".

AUTHOR

       Paul Evans <leonerd@leonerd.org.uk>

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

Check Out this Related Man Page

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

NAME

       IO::Async::Loop::Epoll - use "IO::Async" with "epoll" on Linux

SYNOPSIS

	use IO::Async::Loop::Epoll;

	use IO::Async::Stream;
	use IO::Async::Signal;

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

	$loop->add( IO::Async::Stream->new(
	      read_handle => *STDIN,
	      on_read => sub {
		 my ( $self, $buffref ) = @_;
		 while( $$buffref =~ s/^(.*)
?
// ) {
		    print "You said: $1
";
		 }
	      },
	) );

	$loop->add( IO::Async::Signal->new(
	      name => 'INT',
	      on_receipt => sub {
		 print "SIGINT, will now quit
";
		 $loop->loop_stop;
	      },
	) );

	$loop->loop_forever();

DESCRIPTION

       This subclass of IO::Async::Loop uses IO::Epoll to perform read-ready and write-ready tests so that the O(1) high-performance multiplexing
       of Linux's epoll_pwait(2) syscall can be used.

       The "epoll" Linux subsystem uses a registration system similar to the higher level IO::Poll object wrapper, meaning that better performance
       can be achieved in programs using a large number of filehandles. Each epoll_pwait(2) syscall only has an overhead proportional to the
       number of ready filehandles, rather than the total number being watched. For more detail, see the epoll(7) manpage.

       This class uses the epoll_pwait(2) system call, which atomically switches the process's signal mask, performs a wait exactly as
       epoll_wait(2) would, then switches it back. This allows a process to block the signals it cares about, but switch in an empty signal mask
       during the poll, allowing it to handle file IO and signals concurrently.

CONSTRUCTOR

   $loop = IO::Async::Loop::Epoll->new()
       This function returns a new instance of a "IO::Async::Loop::Epoll" object.

METHODS

       As this is a subclass of IO::Async::Loop, all of its methods are inherited.  Expect where noted below, all of the class's methods behave
       identically to "IO::Async::Loop".

   $count = $loop->loop_once( $timeout )
       This method calls the "poll()" method on the stored "IO::Epoll" object, passing in the value of $timeout, and processes the results of that
       call.  It returns the total number of "IO::Async::Notifier" callbacks invoked, or "undef" if the underlying "epoll_pwait()" method returned
       an error. If the "epoll_pwait()" was interrupted by a signal, then 0 is returned instead.

SEE ALSO

       o   IO::Epoll - Scalable IO Multiplexing for Linux 2.5.44 and higher

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

AUTHOR

       Paul Evans <leonerd@leonerd.org.uk>

perl v5.14.2							    2012-04-10					       IO::Async::Loop::Epoll(3pm)

Linux and UNIX Man Pages

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

Check Out this Related Man Page