GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Reflex::Role::Readable(3) User Contributed Perl Documentation Reflex::Role::Readable(3)

Reflex::Role::Readable - add readable-watching behavior to a class

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

        use Moose;

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

        with 'Reflex::Role::Readable' => {
                handle   => 'socket',
                cb_ready => 'on_socket_readable',
                active   => 1,
        };

        sub on_socket_readable {
                my ($self, $arg) = @_;
                print "Data is ready on socket $arg->{handle}.\n";
                $self->pause_socket_readabe();
        }

Reflex::Role::Readable is a Moose parameterized role that adds readable-watching behavior for Reflex-based classes. In the SYNOPSIS, a filehandle named "socket" is watched for readability. The method on_socket_readable() is called when data becomes available.

TODO - Explain the difference between role-based and object-based composition.

handle

The "handle" parameter must contain the name of the attribute that holds the handle to watch. The name indirection allows the role to generate unique methods by default. For example, a handle named "XYZ" would generates these methods by default:

        cb_ready      => "on_XYZ_readable",
        method_pause  => "pause_XYZ_readable",
        method_resume => "resume_XYZ_readable",
        method_stop   => "stop_XYZ_readable",

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.

active

"active" specifies whether the Reflex::Role::Readable watcher should be enabled when it's initialized. All Reflex watchers are enabled by default. Set it to a false value, preferably 0, to initialize the watcher in an inactive or paused mode.

Readability watchers may be paused and resumed. See "method_pause" and "method_resume" for ways to override the default method names.

cb_ready

"cb_ready" names the $self method that will be called whenever "handle" has data to be read. By default, it's the catenation of "on_", the "handle" name, and "_readable". A handle named "XYZ" will by default trigger on_XYZ_readable() callbacks.

        handle => "socket",  # on_socket_readable()
        handle => "XYZ",     # on_XYZ_readable()

All Reflex parameterized role callbacks are invoked with two parameters: $self and an anonymous hashref of named values specific to the callback. "cb_ready" callbacks include a single named value, "handle", that contains the filehandle from which has become ready for reading.

"handle" is the handle itself, not the handle attribute's name.

method_pause

"method_pause" sets the name of the method that may be used to pause the watcher. It is "pause_${handle}_readable" by default.

method_resume

"method_resume" may be used to resume paused readability watchers, or to activate them if they are started in an inactive state.

method_stop

"method_stop" may be used to stop readability watchers. These watchers may not be restarted once they've been stopped. If you want to pause and resume watching, see "method_pause" and "method_resume".

TODO - I'm sure there are some.

Please see those modules/websites for more information related to this module.
  • Reflex
  • Reflex
  • Reflex::Role::Writable
  • Reflex::Role::Streaming
  • "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

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

Rocco Caputo <rcaputo@cpan.org>

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.

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/>.

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.

2017-04-02 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.