Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Reflex::Connector(3)  User Contributed Perl Documentation Reflex::Connector(3)

NAME
       Reflex::Connector - non-blocking	client socket connector

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

SYNOPSIS
       This is a partial excerpt from eg/eg-38-promise-client.pl

	       use Reflex::Connector;
	       use Reflex::Stream;

	       my $connector = Reflex::Connector->new(port => 12345);

	       my $event = $connector->next();
	       if ($event->{name} eq "failure")	{
		       die("error $event->{arg}{errnum}: $event->{arg}{errstr}");
	       }

	       my $stream = Reflex::Stream->new(
		       handle => $event->{arg}{socket},
	       );

DESCRIPTION
       Reflex::Connector asynchronously	establishes a client connection.  It
       is almost entirely implemented in Reflex::Role::Connecting.  That
       role's documentation contains important details that won't be covered
       here.

   Public Attributes
       address

       "address" defines the remote address to which Reflex::Connector will
       attempt a connection.  It defaults to "127.0.0.1".  See
       Reflex::Role::Connecting	for more details.

       port

       "port" defines the remote port to which Reflex::Connector will attempt
       a connection.  It has no	default.  See Reflex::Role::Connecting for
       more details.

       socket

       Reflex::Connector will provide its own socket by	default.  It also
       accepts a "socket" that may be configured in custom ways.

       See "connector" in Reflex::Role::Connecting for more details.

   Public Methods
       None.

   Callbacks
       on_connection

       "on_connection" is called when Reflex::Connector	establishes a
       connection.  Reflex::Role::Connecting explains the data returned	with
       "on_connection".	 If necessary, that role will also define a default
       "on_connection" handler that emits "success" event.  (TODO - Does this
       make sense?)

       on_error

       "on_error" is called whenever a connection fails	for some reason.
       returns an error.  Reflex::Role::Connecting 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::Connector emits events related to establishing clinet
       connections.  These events are defined by Reflex::Role::Connecting, and
       they will be explained there.

       success

       If no "on_connection" handler is	set, then Reflex::Connector will emit
       a "success" event if the	connection is successfuly established.
       Reflex::Role::Connecting	explains this event in more detail.

       error

       If no "on_error"	handler	is set,	then Reflex::Connector will emit an
       "error" event whenever a	connection fails to establish.
       Reflex::Role::Connecting	explains this event in more detail.

EXAMPLES
       The SYNOPSIS is a partial excerpt from eg/eg-38-promise-client.pl

       eg/eg-35-tcp-client.pl is a more	callbacky client.

SEE ALSO
       Please see those	modules/websites for more information related to this
       module.

       o   Reflex

       o   Reflex

       o   Reflex::Role::Connecting

       o   Reflex::Role::Accepting

       o   Reflex::Acceptor

       o   "ACKNOWLEDGEMENTS" in Reflex

       o   "ASSISTANCE"	in Reflex

       o   "AUTHORS" in	Reflex

       o   "BUGS" in Reflex

       o   "BUGS" in Reflex

       o   "CONTRIBUTORS" in Reflex

       o   "COPYRIGHT" in Reflex

       o   "LICENSE" in	Reflex

       o   "TODO" in Reflex

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

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.

perl v5.24.1			  2017-04-02		  Reflex::Connector(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | EXAMPLES | SEE ALSO | BUGS AND LIMITATIONS | AUTHOR | COPYRIGHT AND LICENSE | AVAILABILITY | DISCLAIMER OF WARRANTY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Reflex::Connector&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help