NAME

Reflex::Role::Streaming - add streaming I/O behavior to a class

VERSION

version 0.088

SYNOPSIS

        use Moose;

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

        with 'Reflex::Role::Streaming' => {
                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) = @_;
                $self->put_socket($arg->{data});
        }

        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::Streaming is a Moose parameterized role that adds streaming I/O behavior to Reflex-based classes. In the SYNOPSIS, a filehandle named "socket" is turned into a NBIO stream by the addition addition of Reflex::Role::Streaming.

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 contains the handle to stream. 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_put  => "put_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_put

method_put defines the name of a method that will write data octets to the role's handle, or buffer them if the handle can't accept them. It's implemented in terms of Reflex::Role::Writing, and it adds code to flush the buffer in the background using Reflex::Role::Writable. The method created by method_put returns the same value as "method_put" in Reflex::Role::Writing does: a status of the output buffer after flushing is attempted.

The default name for method_put is "put_" followed by the streaming handle's name, such as put_XYZ().

The put method takes an list of strings of raw octets:

        my $pending_count = $self->put_XYZ(
                "raw octets here", " and some more"
        );

If method_put's method encounters an error, it invokes the cb_error callback before returning undef. The method_put method returns 0 if all the data was successfully written, 1 if the buffer is beginning to hold data, or 2 if the buffer already had data and now has more.

EXAMPLES

TODO - I'm sure there are some.

SEE ALSO

Reflex Reflex::Role::Readable Reflex::Role::Writable Reflex::Stream

"ACKNOWLEDGEMENTS" in Reflex "ASSISTANCE" in Reflex "AUTHORS" in Reflex "BUGS" in Reflex "BUGS" in Reflex "CONTRIBUTORS" in Reflex "COPYRIGHT" in Reflex "LICENSE" in Reflex "TODO" in Reflex

cpanm Reflex

perl -MCPAN -e shell
install Reflex