Sebastian Riedel > Mojolicious > Mojo::IOLoop::Server

Download:
Mojolicious-4.93.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

Mojo::IOLoop::Server - Non-blocking TCP server

SYNOPSIS ^

  use Mojo::IOLoop::Server;

  # Create listen socket
  my $server = Mojo::IOLoop::Server->new;
  $server->on(accept => sub {
    my ($server, $handle) = @_;
    ...
  });
  $server->listen(port => 3000);

  # Start and stop accepting connections
  $server->start;
  $server->stop;

  # Start reactor if necessary
  $server->reactor->start unless $server->reactor->is_running;

DESCRIPTION ^

Mojo::IOLoop::Server accepts TCP connections for Mojo::IOLoop.

EVENTS ^

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

accept

  $server->on(accept => sub {
    my ($server, $handle) = @_;
    ...
  });

Emitted safely for each accepted connection.

ATTRIBUTES ^

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

multi_accept

  my $multi = $server->multi_accept;
  $server   = $server->multi_accept(100);

Number of connections to accept at once, defaults to 50.

reactor

  my $reactor = $server->reactor;
  $server     = $server->reactor(Mojo::Reactor::Poll->new);

Low-level event reactor, defaults to the reactor attribute value of the global Mojo::IOLoop singleton.

METHODS ^

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

generate_port

  my $port = $server->generate_port;

Find a free TCP port, this is a utility function primarily used for tests.

handle

  my $handle = $server->handle;

Get handle for server.

listen

  $server->listen(port => 3000);

Create a new listen socket. Note that TLS support depends on IO::Socket::SSL (1.84+) and IPv6 support on IO::Socket::IP (0.20+).

These options are currently available:

address
  address => '127.0.0.1'

Local address to listen on, defaults to all.

backlog
  backlog => 128

Maximum backlog size, defaults to SOMAXCONN.

port
  port => 80

Port to listen on.

reuse
  reuse => 1

Allow multiple servers to use the same port with the SO_REUSEPORT socket option.

tls
  tls => 1

Enable TLS.

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

Path to TLS certificate authority file.

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

Path to the TLS cert file, defaults to a built-in test certificate.

tls_ciphers
  tls_ciphers => 'AES128-GCM-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH'

Cipher specification string, defaults to ECDHE-RSA-AES128-SHA256:AES128-GCM-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH.

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

Path to the TLS key file, defaults to a built-in test key.

tls_verify
  tls_verify => 0x00

TLS verification mode, defaults to 0x03.

start

  $server->start;

Start accepting connections.

stop

  $server->stop;

Stop accepting connections.

SEE ALSO ^

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

syntax highlighting: