/ 
Reflexive-Stream-Filtering-1.122150
River stage one • 1 direct dependent • 1 total dependent
/ Reflexive::Stream::Filtering

NAME

Reflexive::Stream::Filtering - Provides a Reflex Stream object that can use POE::Filters

VERSION

version 1.122150

DESCRIPTION

Reflexive::Stream::Filtering provides a Reflex::Stream subclass that takes and uses a POE::Filter instance to filter inbound and outbound data similar to a POE::Wheel object. But this class is much much simpler. The goal is to merely shim in a POE::Filter instance and to do it as unobtrusively as possible.

The main implemetation of this functionality is actually within Reflexive::Role::StreamFiltering. Its documentation is included here for convenience.

PUBLIC_ATTRIBUTES

input_filter

is: rw, isa: POE::Filter, default: POE::Filter::Stream

This attribute is mostly to be provided at construction of the Stream. If none is provided then POE::Filter::Stream (which is just a passthrough) is used.

Internally, the following handles are provided:

'filter_get' => 'get_one',
'filter_start' => 'get_one_start',

Incidentially, only the newer POE::Filter get_one_start/get_one interace is supported.

output_filter

is: rw, isa: POE::Filter, default: POE::Filter::Stream

Like the input_filter attribute, this is to be provided at construction time of the Stream. If an output_filter is not provided, POE::Filter::Stream is used.

The following handles are provided:

'filter_put' => 'put'

PUBLIC_METHODS

put

(Any)

This method is around advised to run the provided data through the filter before passing it along to the original method if the filter returns multiple filtered chunks then each chunk will get its own method call.

PROTECTED_METHODS

on_data

(Reflexive::Event::Data)

on_data is the advised to intercept data events. Data is passed through the ilter via get_one_start. Then get_one is called until no more filtered chunks are returned. Each filtered chunk is then delievered via the emitted data event which is reemitted.

CAVEATS

The filter attributes are marked as read-write, but take care when swapping filters as the filters may have data left in their buffers. This module isn't quite as smart as POE::Wheel::ReadWrite and it won't automagically pull any buffered data out of the previous filter and apply it to the new filter.

AUTHOR

Nicholas R. Perez <nperez@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Nicholas R. Perez <nperez@cpan.org>.

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