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

FreeBSD Manual Pages

  
 
  

home | help
Reflex::Stream(3)     User Contributed Perl Documentation    Reflex::Stream(3)

NAME
       Reflex::Stream -	Buffered, translated I/O on non-blocking handles.

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

SYNOPSIS
       This is a complete Reflex::Stream subclass.  It echoes whatever it
       receives	back to	the sender.  Its error handlers	are compatible with
       Reflex::Collection.

	       package EchoStream;
	       use Moose;
	       extends 'Reflex::Stream';

	       sub on_data {
		       my ($self, $event) = @_;
		       $self->put($event->octets());
	       }

	       sub on_error {
		       my ($self, $event) = @_;
		       warn(
			       $event->error_function(),
			       " error ", $event->error_number(),
			       ": ", $event->error_string(),
		       );
		       $self->stopped();
	       }

	       sub DEMOLISH {
		       print "EchoStream demolished as it should.\n";
	       }

	       1;

       Since it	extends	Reflex::Base, it may also be used like a condavr or
       promise.	 This incomplte	example	comes from eg/eg-38-promise-client.pl:

	       my $stream = Reflex::Stream->new(
		       handle => $socket
		       rd     => 1,
	       );

	       $stream->put("Hello, world!\n");

	       my $event = $stream->next();
	       if ($event->{name} eq "data") {
		       print "Got echo response: $event->{arg}{data}";
	       }
	       else {
		       print "Unexpected event:	$event->{name}";
	       }

DESCRIPTION
       Reflex::Stream reads from and writes to a file handle, most often a
       socket.	It is almost entirely implemented in Reflex::Role::Streaming.
       That role's documentation contains important details that won't be
       covered here.

   Public Attributes
       handle

       Reflex::Stream implements a single attribute, handle, that must be set
       to the stream's file handle (which can be a socket or something).

   Public Methods
       Reflex::Role::Streaming provides	all of Reflex::Stream's	methods.
       Reflex::Stream however renames them to make more	sense in a class.

       put

       The put() method	writes one or more chunks of raw octets	to the
       stream's	handle.	 Any data that cannot be written immediately will be
       buffered	until Reflex::Role::Streaming can write	it later.

       Please see "method_put" in Reflex::Role::Streaming for details.

   Callbacks
       on_closed

       Subclasses may define on_closed() to be notified	when the remote	end of
       the stream has closed for output.  No further data will be received
       after receipt of	this callback.

       on_closed() receives no parameters of note.

       The default on_closed() callback	will emit a "closed" event.  It	will
       also call stopped().

       When overriding this callback, please be	sure to	call stopped(),	which
       is provided by Reflex::Role::Collectible.  Calling stopped() is vital
       for collectible objects to be released from memory when managed by
       Reflex::Collection.

       on_data

       on_data() will be called	whenever Reflex::Stream	receives data.	It
       will include one	named parameter	in $_[1], "data", containing raw
       octets received from the	stream.

	       sub on_data {
		       my ($self, $param) = @_;
		       print "Got data:	$param->{data}\n";
	       }

       The default on_data() callback will emit	a "data" event.

       on_error

       on_error() will be called if an error occurs reading from or writing to
       the stream's handle.  Its parameters are	the usual for Reflex:

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

       The default on_error() callback will emit a "error" event.  It will
       also call stopped().

       When overriding this callback, please be	sure to	call stopped(),	which
       is provided by Reflex::Role::Collectible.  Calling stopped() is vital
       for collectible objects to be released from memory when managed by
       Reflex::Collection.

   Public Events
       Reflex::Stream emits stream-related events, naturally.

       closed

       The "closed" event indicates that the stream is closed.	This is	most
       often caused by the remote end of a socket closing their	connection.

       See "on_closed" for more	details.

       data

       The "data" event	is emitted when	a stream produces data to work with.
       It includes a single parameter, also "data", containing the raw octets
       read from the handle.

       See "on_data" for more details.

       error

       Reflex::Stream emits "error" when any of	a number of calls fails.

       See "on_error" for more details.

EXAMPLES
       eg/EchoStream.pm	in the distribution is the same	EchoStream that
       appears in the SYNOPSIS.

       eg/eg-38-promise-client.pl shows	a lengthy inline usage of
       Reflex::Stream and a few	other classes.

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

       o   Reflex

       o   Reflex

       o   Reflex::Listener

       o   Reflex::Connector

       o   Reflex::UdpPeer

       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.24.1			  2017-04-02		     Reflex::Stream(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::Stream&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help