The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

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

DESCRIPTION

Mojo::IOLoop::Client opens TCP connections for Mojo::IOLoop. Note that this module is EXPERIMENTAL and might change without warning!

EVENTS

Mojo::IOLoop::Client can emit the following events.

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 happens on the connection.

ATTRIBUTES

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

iowatcher

my $watcher = $client->iowatcher;
$client     = $client->iowatcher(Mojo::IOWatcher->new);

Low level event watcher, defaults to the iowatcher 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 and IPv6 support on IO::Socket::IP.

These options are currently available:

address

Address or host name of the peer to connect to.

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.

tls

Enable TLS.

tls_ca

Path to TLS certificate authority file.

tls_cert

Path to the TLS certificate file.

tls_key

Path to the TLS key file.

SEE ALSO

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