NAME

Reflex::Acceptor - a non-blocking server (client socket acceptor)

VERSION

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

SYNOPSIS

        package TcpEchoServer;

        use Moose;
        extends 'Reflex::Acceptor';
        use Reflex::Collection;
        use EchoStream;

        has_many clients => ( handles => { remember_client => "remember" } );

        sub on_accept {
                my ($self, $event) = @_;
                $self->remember_client(
                        EchoStream->new(
                                handle => $event->socket(),
                                rd     => 1,
                        )
                );
        }

        sub on_error {
                my ($self, $event) = @_;
                warn(
                        $event->error_function(),
                        " error ", $event->error_number(),
                        ": ", $event->error_string(),
                        "\n"
                );
                $self->stop();
        }

DESCRIPTION

Reflex::Acceptor takes a listening socket and produces new sockets for clients that connect to it. It is almost entirely implemented in Reflex::Role::Accepting. That role's documentation contains important details that won't be covered here.

Public Attributes

listener

Reflex::Acceptor defines a single attribute, "listner", which should be set to a listening socket of some kind. Reflex::Acceptor requires an externally supplied socket so that the user may specify any and all applicable socket options.

If necessary, the class may later supply a basic socket by default.

Reflex::Role::Accepting explains "listener" in more detail.

Public Methods

pause

pause() will temporarily stop the server from accepting more clients. See "method_pause" in Reflex::Role::Accepting for details.

resume

resume() will resume a temporarily stopped server so that it may accept more client connections. See "method_resume" in Reflex::Role::Accepting for details.

stop

stop() will permanently stop the server from accepting more clients. See "method_stop" in Reflex::Role::Accepting for details.

Callbacks

on_accept

"on_accept" is called whenever Perl's built-in accept() function returns a socket. Reflex::Role::Accepting explains the data returned with "on_accept". If necessary, that role will also define a default "on_accept" handler that emits an "accept" event.

on_error

"on_error" is called whenever Perl's built-in accept() function returns an error. Reflex::Role::Accepting explains the data returned with "on_error". If necessary, that role will also define a default "on_error" handler that emits an "error" event.

Public Events

Reflex::Acceptor emits events related to accepting client connections. These events are defined by Reflex::Role::Accepting, and they will be explained there.

accept

If no "on_accept" handler is set, then Reflex::Acceptor will emit an "accept" event for every client connection accepted. Reflex::Role::Accepting explains this event in more detail.

error

If no "on_error" handler is set, then Reflex::Acceptor will emit an "error" event every time accept() returns an error. Reflex::Role::Accepting explains this event in more detail.

EXAMPLES

The SYNOPSIS is an excerpt from eg/eg-34-tcp-server-echo.pl.

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