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 => 'example.com', 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 if an error occurs on the connection, fatal if unhandled.

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 => 'mojolicio.us'
            
          

Address or host name of the peer to connect to, defaults to localhost.

handle

            

              
              
handle => $handle
            
          

Use an already prepared handle.

local_address

            

              
              
local_address => '127.0.0.1'
            
          

Local address to bind to.

port

            

              
              
port => 80
            
          

Port to connect to, defaults to 80 or 443 with tls option.

timeout

            

              
              
timeout => 15
            
          

Maximum amount of time in seconds establishing connection may take before getting canceled, defaults to 10.

tls

            

              
              
tls => 1
            
          

Enable TLS.

tls_ca

            

              
              
tls_ca => '/etc/tls/ca.crt'
            
          

Path to TLS certificate authority file. Also activates hostname verification.

tls_cert

            

              
              
tls_cert => '/etc/tls/client.crt'
            
          

Path to the TLS certificate file.

tls_key

            

              
              
tls_key => '/etc/tls/client.key'
            
          

Path to the TLS key file.

SEE ALSO

Mojolicious, Mojolicious::Guides, http://mojolicio.us.