NAME

Reflex::Role::Accepting - add connection accepting to a class

VERSION

version 0.081

SYNOPSIS

        package Reflex::Acceptor;

        use Moose;
        extends 'Reflex::Base';

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

        with 'Reflex::Role::Accepting' => {
                listener      => 'listener',
                cb_accept     => 'on_accept',
                cb_error      => 'on_error',
                method_pause  => 'pause',
                method_resume => 'resume',
                method_stop   => 'stop',
        };

        1;

DESCRIPTION

Reflex::Role::Accepting is a Moose parameterized role that adds accept() reactions to classes that contain listening sockets. Because it's a role, the class composition happens before runtime, as opposed to runtime composition that occurs in other reactive libraries.

See Reflex::Acceptor if you prefer runtime composition with objects, or if Moose syntax just gives you the heebie-jeebies.

Required Role Parameters

listener

The listener parameter must contain the name of an attribute that contains the listening socket handle. The name indirection allows the role to generate methods that are unique to the listening socket. This becomes important when a class wants to listen on more than one socket---each socket gets its own name, and distinct methods to tell them apart.

For example, a listener named "XYZ" would generate these methods by default:

        cb_accept     => "on_XYZ_accept",
        cb_error      => "on_XYZ_error",
        method_pause  => "pause_XYZ",
        # ... and so on.

Optional Role Parameters

cb_accept

cb_accept overrides the default name for the class's accept handler method. This handler will be called whenever a client connection is successfully accepted.

The default method name is "on_${listener}_accept", where $listener is the name of the listening socket attribute. This role defines a default callback that emits an "accept" event.

All callback methods receive two parameters: $self and an anonymous hash containing information specific to the callback. In cb_accept's case, the anonymous hash contains two values: accept()'s return value is named "peer", and the accepted client socket is named "socket".

See perldoc -f accept() for more information about "peer" and "socket".

cb_error

cb_error names the $self method that will be called whenever accept() encounters an error. By default, this method will be the catenation of "on_", the listener name, and "_error". As in on_XYZ_error(), if the listener is named "XYZ". The role defines a default callback that will emit an "error" event with cb_error()'s parameters.

cb_error callbacks receive two parameters, $self and an anonymous hashref of named values specific to the callback. Reflex error callbacks include three standard values. errfun contains a single word description of the function that failed. errnum contains the numeric value of $! at the time of failure. errstr holds the stringified version of $!.

Values of $! are passed as parameters since the global variable may change before the callback can be invoked.

When overriding this callback, please be sure to call stopped(), which is provided by Reflex::Role::Collectible. Calling stopped() is vital for collectible objects to be released from memory when managed by Reflex::Collection.

method_pause

method_pause defines the name of a method that will temporarily pause the class from accepting new clients. The role will define this method for you. The default method name is "pause_${listener}", where $listener is the name of the listening socket attribute.

method_resume

method_resume defines the name of a method that will allow the class to resume accepting new client connections. The role will define this method for you. The default method name is "resume_${listener}", where $listener is the name of the listening socket attribute.

method_stop

method_stop defines the name of a method that will permanently stop the class from accepting new clients. The role will define this method for you. The default method name is "stop_${listener}", where $listener is the name of the listening socket attribute.

EXAMPLES

TODO - I'm sure there are some.

SEE ALSO

Reflex Reflex::Role::Connecting Reflex::Acceptor Reflex::Connector

"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

cpanm Reflex

perl -MCPAN -e shell
install Reflex