NAME

Reflex::Client - A non-blocking socket client.

VERSION

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

SYNOPSIS

This is a complete working TCP echo client. It's the version of eg/eg-35-tcp-client.pl available at the time of this writing.

        use lib qw(../lib);

        {
                package TcpEchoClient;
                use Moose;
                extends 'Reflex::Client';

                sub on_client_connected {
                        my ($self, $event) = @_;
                        $self->connection()->put("Hello, world!\n");
                };

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

                        # Not chomped.
                        warn "got from server: ", $event->data();

                        # Disconnect after we receive the echo.
                        $self->stop();
                }
        }

        TcpEchoClient->new(
                remote_addr => '127.0.0.1',
                remote_port => 12345,
        )->run_all();

DESCRIPTION

Reflex::Client is scheduled for substantial changes. One of its base classes, Reflex::Handle, will be deprecated in favor of Reflex::Role::Readable and Reflex::Role::Writable. Hopefully Reflex::Client's interfaces won't change much as a result, but there are no guarantees. Your ideas and feedback for Reflex::Client's future implementation are welcome.

Reflex::Client is a high-level base class for non-blocking socket clients. As with other Reflex::Base classes, this one may be subclassed, composed with "has", or driven inline with promises.

Attributes

Reflex::Client extends (and includes the attributes of) Reflex::Connector, which extends Reflex::Handle. It also provides its own attributes.

protocol

The "protocol" attribute contains the name of a class that will handle I/O for the client. It contains "Reflex::Stream" by default.

Protocol classes should extend Reflex::Stream or at least follow its interface.

Public Methods

Reflex::Client extends Reflex::Handle, but it currently provides no additional methods.

Events

Reflex::Client emits some of its own high-level events based on its components' activities.

connected

Reflex::Client emits "connected" to notify consumers when the client has connected, and it's safe to begin sending data.

data

Reflex::Client emits stream data with the "data" event. This event is provided by Reflex::Stream. Please see "data" in Reflex::Stream for the most current documentation.

EXAMPLES

eg/eg-35-tcp-client.pl subclasses Reflex::Client as TcpEchoClient.

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.