Scroll to navigation

Mojo::IOLoop::Client(3pm) User Contributed Perl Documentation Mojo::IOLoop::Client(3pm)

NAME

Mojo::IOLoop::Client - Non-blocking TCP client

SYNOPSIS

  use Mojo::IOLoop::Client;
  # Create socket connection
  my $client = Mojo::IOLoop::Client->new;
  $client->on(connect => sub {
    my ($client, $handle) = @_;
    ...
  });
  $client->on(error => sub {
    my ($client, $err) = @_;
    ...
  });
  $client->connect(address => 'mojolicio.us', port => 80);
  # Start reactor if necessary
  $client->reactor->start unless $client->reactor->is_running;

DESCRIPTION

Mojo::IOLoop::Client opens TCP connections for Mojo::IOLoop.

EVENTS

Mojo::IOLoop::Client inherits all events from Mojo::EventEmitter and can emit the following new ones.

connect

  $client->on(connect => sub {
    my ($client, $handle) = @_;
    ...
  });
Emitted safely once the connection is established.

error

  $client->on(error => sub {
    my ($client, $err) = @_;
    ...
  });
Emitted safely if an error occurs on the connection.

ATTRIBUTES

Mojo::IOLoop::Client implements the following attributes.

reactor

  my $reactor = $client->reactor;
  $client     = $client->reactor(Mojo::Reactor::Poll->new);
Low level event reactor, defaults to the "reactor" attribute value of the global Mojo::IOLoop singleton.

METHODS

Mojo::IOLoop::Client inherits all methods from Mojo::EventEmitter and implements the following new ones.

connect

  $client->connect(address => '127.0.0.1', port => 3000);
Open a socket connection to a remote host. Note that TLS support depends on IO::Socket::SSL (1.75+) and IPv6 support on IO::Socket::IP (0.16+).
These options are currently available:
address
Address or host name of the peer to connect to, defaults to "localhost".
handle
Use an already prepared handle.
local_address
Local address to bind to.
port
Port to connect to.
timeout
Maximum amount of time in seconds establishing connection may take before getting canceled, defaults to 10.
tls
Enable TLS.
tls_ca
Path to TLS certificate authority file. Also activates hostname verification.
tls_cert
Path to the TLS certificate file.
tls_key
Path to the TLS key file.

SEE ALSO

Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.
2013-02-19 perl v5.14.2