Alexei Znamensky > DataFlow-1.121830 > DataFlow::ProcWrapper

Download:
DataFlow-1.121830.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  12
Open  1
View/Report Bugs
Module Version: 1.121830   Source  

NAME ^

DataFlow::ProcWrapper - Wrapper around a processor

VERSION ^

version 1.121830

SYNOPSIS ^

    use DataFlow::ProcWrapper;
    use DataFlow::Item;

        my $wrapper = DataFlow::ProcWrapper->new( wraps => sub { lc } );
        my $item = DataFlow::Item->itemize( 'default', 'WAKAWAKAWAKA' );
        my @result = $wrapper->process($item);
        # $result[0]->get_data('default') equals to 'wakawakawaka'

DESCRIPTION ^

This class DataFlow::ProcWrapper consumes the DataFlow::Role::Processor role, but this is not a "common" processor and it should not be used as such. Actually, it is supposed to be used internally by DataFlow alone, so in theory, if not in practice, we should be able to ignore its existence.

ProcWrapper will, as the name suggests, wraps around a processor (read a Proc, a DataFlow, a naked sub or a named processor), and provides a layer of control on the input and output channels.

ATTRIBUTES ^

input_chan

Name of the input channel. The DataFlow::Item may carry data in distinct "channels", and here we can select which channel we will take the data from. If not specified, it will default to the literal string 'default'.

output_chan

Similarly, the output channel's name. If not specified, it will default to the same channel used for input.

METHODS ^

process

This works like the regular process() method in a processor, except that it expects to receive an object of the type DataFlow::Item.

Additionaly, one can pass a random scalar as argument, and add a second argument that evaluates to a true value, and the scalar argument will be automagically "boxed" into a DataFlow::Item object.

Once the data is within a DataFlow::Item, data will be pulled from the specified channel, will call the wrapped processor's process() method.

It will always return an array with one or more elements, all of them of the DataFlow::Item type.

SEE ALSO ^

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

AUTHOR ^

Alexei Znamensky <russoz@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Alexei Znamensky.

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

BUGS AND LIMITATIONS ^

You can make new bug reports, and view existing ones, through the web interface at http://rt.cpan.org.

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.

syntax highlighting: