NAME

Reflex::Role::OutStreaming - add streaming input behavior to a class

VERSION

version 0.088

SYNOPSIS

        use Moose;

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

        with 'Reflex::Role::OutStreaming' => {
                handle     => 'socket',
                method_put => 'put',
        };

DESCRIPTION

Reflex::Role::OutStreaming is a Moose parameterized role that adds non-blocking output behavior to Reflex-based classes. It comprises Reflex::Role::Collectible for dynamic composition, Reflex::Role::Writable for asynchronous output callbacks, and Reflex::Role::Writing to buffer and flush output when it can.

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_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_error

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

method_put

Please see "method_put" in Reflex::Role::Writing. Reflex::Role::Writing's "method_put" defines this method.

EXAMPLES

See eg/RunnerRole.pm in the distribution.

SEE ALSO

Reflex Reflex::Role::Writable Reflex::Role::Writing 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