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

FreeBSD Manual Pages

  
 
  

home | help
Mojo::IOLoop::Server(3User Contributed Perl DocumentatiMojo::IOLoop::Server(3)

NAME
       Mojo::IOLoop::Server - Non-blocking TCP and UNIX	domain socket 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/IP and UNIX domain socket 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 for each	accepted connection.

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

   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 = Mojo::IOLoop::Server->generate_port;

       Find a free TCP port, primarily used for	tests.

   handle
	 my $handle = $server->handle;

       Get handle for server, usually an IO::Socket::IP	object.

   is_accepting
	 my $bool = $server->is_accepting;

       Check if	connections are	currently being	accepted.

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

       Create a	new listen socket. Note	that TLS support depends on
       IO::Socket::SSL (1.94+).

       These options are currently available:

       address
	   address => '127.0.0.1'

	 Local address to listen on, defaults to 0.0.0.0.

       backlog
	   backlog => 128

	 Maximum backlog size, defaults	to "SOMAXCONN".

       path
	   path	=> '/tmp/myapp.sock'

	 Path for UNIX domain socket to	listen on.

       port
	   port	=> 80

	 Port to listen	on, defaults to	a random port.

       reuse
	   reuse => 1

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

       single_accept
	   single_accept => 1

	 Only accept one connection at a time.

       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'
	   tls_cert => {'mojolicious.org' => '/etc/tls/mojo.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'

	 TLS cipher specification string. For more information about the
	 format	see
	 <https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-STRINGS>.

       tls_key
	   tls_key => '/etc/tls/server.key'
	   tls_key => {'mojolicious.org' => '/etc/tls/mojo.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 if a certificate authority
	 file has been provided, or 0x00.

       tls_version
	   tls_version => 'TLSv1_2'

	 TLS protocol version.

   port
	 my $port = $server->port;

       Get port	this server is listening on.

   start
	 $server->start;

       Start or	resume accepting connections.

   stop
	 $server->stop;

       Stop accepting connections.

SEE ALSO
       Mojolicious, Mojolicious::Guides, <http://mojolicious.org>.

perl v5.24.1			  2017-02-27	       Mojo::IOLoop::Server(3)

NAME | SYNOPSIS | DESCRIPTION | EVENTS | ATTRIBUTES | METHODS | SEE ALSO

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

home | help