The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Reflex-0.100
River stage one • 7 direct dependents • 7 total dependents
13 ++
/ Reflex::POE::Postback

NAME

Reflex::POE::Postback - Communicate with POE components expecting postbacks.

VERSION

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

SYNOPSIS

Not a complete example. Please see eg-11-poco-postback.pl in the eg directory for a complete working program.

        my $postback = Reflex::POE::Postback->new(
                $self, "on_component_result", { cookie => 123 }
        );

DESCRIPTION

Reflex::POE::Postback creates an object that's substitutes for POE::Session postbacks. When invoked, however, they sent events back to the object and method (and with optional continuation data) provided during construction.

Reflex::POE::Postback was designed to interact with POE modules that want to respond via caller-provided postbacks. Authors are encouraged to encapsulate POE interaction within Reflex objects. Most users should therefore not need use Reflex::POE::Postback (or other Reflex::POE helpers) directly.

Public Methods

new

new() constructs a new Reflex::POE::Postback object, which will be a blessed coderef following POE's postback convention.

It takes three positional parameters: the required object and method to invoke when the postback is called, and an optional context that will be passed verbatim to the callback.

Callback Parameters

context

The "context" callback parameter contains whatever was supplied to the Reflex::POE::Postback when it was created. In the case of the SYNOPSIS, that would be:

        sub on_component_result {
                my ($self, $event) = @_;

                # Displays: 123
                print $event->context()->{cookie}, "\n";
        }

response

"response" contains an array reference that holds whatever was passed to the postback. If we assume this postback call:

        $postback->(qw(eight six seven five three oh nine));

Then the callback might look something like this:

        sub on_component_result {
                my ($self, $event) = @_;

                # Displays: nine
                print $event->response()->[-1], "\n";
        }

CAVEATS

Reflex::POE::Postback must produce objects as blessed coderefs. This is something I don't know how to do yet with Moose, so Moose isn't used. Therefore, Reflex::POE::Postback doesn't do a lot of things one might expect after working with other Reflex objects.

If Moose can be used later, it may fundamentally change the entire interface. The goal is to do this only once, however.

It might be nice to map positional response parameters to named parameters. Reflex::POE::Wheel does this, but it remains to be seen whether that's considered cumbersome.

SEE ALSO

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

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.