Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Reflex::Role::InStreamUser3Contributed Perl DocumeReflex::Role::InStreaming(3)

NAME
       Reflex::Role::InStreaming - add streaming input behavior	to a class

VERSION
       This document describes version 0.100, released on April	02, 2017.

SYNOPSIS
	       use Moose;

	       has socket => ( is => 'rw', isa => 'FileHandle',	required => 1 );

	       with 'Reflex::Role::InStreaming'	=> {
		       handle	 => 'socket',
		       cb_data	 => 'on_socket_data',	 # default
		       cb_error	 => 'on_socket_error',	 # default
		       cb_closed => 'on_socket_closed',	 # default
	       };

	       sub on_socket_data {
		       my ($self, $arg)	= @_;
		       print "Socket received data: $arg->{data}\n";
	       }

	       sub on_socket_error {
		       my ($self, $arg)	= @_;
		       print "$arg->{errfun} error $arg->{errnum}: $arg->{errstr}\n";
		       $self->stopped();
	       }

	       sub on_socket_closed {
		       my $self	= shift;
		       print "Connection closed.\n";
		       $self->stopped();
	       }

DESCRIPTION
       Reflex::Role::InStreaming is a Moose parameterized role that adds
       asynchronous streaming input behavior to	Reflex-based classes.  It
       comprises Reflex::Role::Collectible for dynamic composition,
       Reflex::Role::Readable for asynchronous input watching, and
       Reflex::Role::Reading to	perform	input.

       See Reflex::Stream if you prefer	runtime	composition with objects, or
       you just	find Moose syntax difficult to handle.

   Required Role Parameters
       handle

       The "handle" parameter must contain the name of the attribute that
       holds a filehandle from which data will be read.	 The name indirection
       allows the role to generate methods that	are unique to the handle.  For
       example,	a handle named "XYZ" would generate these methods by default:

	       cb_closed   => "on_XYZ_closed",
	       cb_data	   => "on_XYZ_data",
	       cb_error	   => "on_XYZ_error",
	       method_stop => "stop_XYZ",

       This naming convention allows the role to be used for more than one
       handle in the same class.  Each handle will have	its own	name, and the
       mixed in	methods	associated with	them will also be unique.

   Optional Role Parameters
       cb_closed

       Please see "cb_closed" in Reflex::Role::Reading.
       Reflex::Role::Reading's "cb_closed" defines this	callback.

       cb_data

       Please see "cb_data" in Reflex::Role::Reading.  Reflex::Role::Reading's
       "cb_data" defines this callback.

       cb_error

       Please see "cb_error" in	Reflex::Role::Reading.
       Reflex::Role::Reading's "cb_error" defines this callback.

       method_stop

       Please see "method_stop"	in Reflex::Role::Readable.
       Reflex::Role::Readable's	"method_stop" defines this method.

EXAMPLES
       See eg/RunnerRole.pm in the distribution.

SEE ALSO
       Please see those	modules/websites for more information related to this
       module.

       o   Reflex

       o   Reflex

       o   Reflex::Role::Readable

       o   Reflex::Role::Reading

       o   Reflex::Stream

       o   "ACKNOWLEDGEMENTS" in Reflex

       o   "ASSISTANCE"	in Reflex

       o   "AUTHORS" in	Reflex

       o   "BUGS" in Reflex

       o   "BUGS" in Reflex

       o   "CONTRIBUTORS" in Reflex

       o   "COPYRIGHT" in Reflex

       o   "LICENSE" in	Reflex

       o   "TODO" in Reflex

BUGS AND LIMITATIONS
       You can make new	bug reports, and view existing ones, through the web
       interface at <http://rt.cpan.org/Public/Dist/Display.html?Name=Reflex>.

AUTHOR
       Rocco Caputo <rcaputo@cpan.org>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2017 by Rocco Caputo.

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

AVAILABILITY
       The latest version of this module is available from the Comprehensive
       Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find
       a CPAN site near	you, or	see <https://metacpan.org/module/Reflex/>.

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS	LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
       FOR THE SOFTWARE, TO THE	EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN	WRITING	THE COPYRIGHT HOLDERS AND/OR OTHER
       PARTIES PROVIDE THE SOFTWARE "AS	IS" WITHOUT WARRANTY OF	ANY KIND,
       EITHER EXPRESSED	OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF	THE SOFTWARE IS	WITH
       YOU. SHOULD THE SOFTWARE	PROVE DEFECTIVE, YOU ASSUME THE	COST OF	ALL
       NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR	AGREED TO IN WRITING
       WILL ANY	COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE	SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE	USE OR INABILITY TO USE	THE
       SOFTWARE	(INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED	INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGES.

perl v5.32.0			  2017-04-02	  Reflex::Role::InStreaming(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO | BUGS AND LIMITATIONS | AUTHOR | COPYRIGHT AND LICENSE | AVAILABILITY | DISCLAIMER OF WARRANTY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Reflex::Role::InStreaming&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help