Rocco Caputo > Reflex > Reflex::POE::Session

Download:
Reflex-0.099.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.099   Source  

NAME ^

Reflex::POE::Session - Watch events from a POE::Session object.

VERSION ^

This document describes version 0.099, released on April 21, 2013.

SYNOPSIS ^

This sample usage is not a complete program. The rest of the program exists in eg-13-irc-bot.pl, in the tarball's eg directory.

        sub BUILD {
                my $self = shift;

                $self->component(
                        POE::Component::IRC->spawn(
                                nick    => "reflex_$$",
                                ircname => "Reflex Test Bot",
                                server  => "10.0.0.25",
                        ) || die "Drat: $!"
                );

                $self->poco_watcher(
                        Reflex::POE::Session->new(
                                sid => $self->component()->session_id(),
                        )
                );

                $self->run_within_session(
                        sub {
                                $self->component()->yield(register => "all");
                                $self->component()->yield(connect  => {});
                        }
                )
        }

DESCRIPTION ^

Reflex::POE::Session allows a Reflex::Base object to receive events from a specific POE::Session instance, identified by the session's ID.

Authors are encouraged to encapsulate POE sessions within Reflex objects. Most users should not need use Reflex::POE::Session (or other Reflex::POE helpers) directly.

Public Attributes

sid

The "sid" must contain the ID of the POE::Session to be watched. This is in fact how Reflex::POE::Session knows which session to watch. See POE for more information about session IDs.

Public Events

Reflex::POE::Session will emit() events on behalf of the watched POE::Session. If the session posts "irc_001", then Reflex::POE::Session will emit "irc_001", and so on.

Reflex::POE::Session's "args" parameter will contain all of the POE event's paramters, from ARG0 through the end of the parameter list. They will be mapped to Reflex paramters "0" through the last index.

Assume that this POE post() call invokes this Reflex callback() via Refex::POE::Session:

        $kernel->post( event => qw(one one two three five) );

        ...;

        sub callback {
                my ($self, $event) = @_;
                print "$_\n" foreach $event->args_list();
        }

The callback will print five lines:

        one
        one
        two
        three
        five

CAVEATS ^

Reflex::POE::Session will take note of every event sent by the session, although it won't try to deliver ones that haven't been registered with the callback object. However, the act of filtering these events out is more overhead than simply not registering interest in the first place. A later version will be more optimal.

Reflex::POE::Wheel provides a way to map parameters to symbolic names. Reflex::POE::Session may also provide a similar mechanism in the future, obsoleting the parameter numbers.

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) 2013 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.

syntax highlighting: