| Mojolicious documentation | Contained in the Mojolicious distribution. |
Mojo::Server::Daemon - Async IO HTTP 1.1 And WebSocket Server
use Mojo::Server::Daemon;
my $daemon = Mojo::Server::Daemon->new(listen => ['http://*:8080']);
$daemon->on_request(sub {
my ($self, $tx) = @_;
# Request
my $method = $tx->req->method;
my $path = $tx->req->url->path;
# Response
$tx->res->code(200);
$tx->res->headers->content_type('text/plain');
$tx->res->body("$method request for $path!");
# Resume transaction
$tx->resume;
});
$daemon->run;
Mojo::Server::Daemon is a full featured async io HTTP 1.1 and WebSocket
server with IPv6, TLS, Bonjour, epoll and kqueue support.
Optional modules IO::KQueue, IO::Epoll, IO::Socket::IP, IO::Socket::SSL and Net::Rendezvous::Publish are supported transparently and used if installed.
See Mojolicious::Guides::Cookbook for deployment recipes.
Mojo::Server::Daemon inherits all attributes from Mojo::Server and implements the following new ones.
backlogmy $backlog = $daemon->backlog; $daemon = $daemon->backlog(128);
Listen backlog size, defaults to SOMAXCONN.
group my $group = $daemon->group;
$daemon = $daemon->group('users');
Group for server process.
ioloopmy $loop = $daemon->ioloop; $daemon = $daemon->ioloop(Mojo::IOLoop->new);
Event loop for server IO, defaults to the global Mojo::IOLoop singleton.
keep_alive_timeoutmy $keep_alive_timeout = $daemon->keep_alive_timeout; $daemon = $daemon->keep_alive_timeout(15);
Maximum amount of time in seconds a connection can be inactive before being
dropped, defaults to 5.
listenmy $listen = $daemon->listen; $daemon = $daemon->listen(['https://localhost:3000']);
List of ports and files to listen on, defaults to http://*:3000.
max_clientsmy $max_clients = $daemon->max_clients; $daemon = $daemon->max_clients(1000);
Maximum number of parallel client connections, defaults to 1000.
max_requestsmy $max_requests = $daemon->max_requests; $daemon = $daemon->max_requests(100);
Maximum number of keep alive requests per connection, defaults to 25.
silentmy $silent = $daemon->silent; $daemon = $daemon->silent(1);
Disable console messages.
user my $user = $daemon->user;
$daemon = $daemon->user('web');
User for the server process.
websocket_timeoutmy $websocket_timeout = $server->websocket_timeout; $server = $server->websocket_timeout(300);
Maximum amount of time in seconds a WebSocket connection can be inactive
before being dropped, defaults to 300.
Mojo::Server::Daemon inherits all methods from Mojo::Server and implements the following new ones.
prepare_ioloop$daemon->prepare_ioloop;
Prepare event loop.
run$daemon->run;
Start server.
setuidgid$daemon->setuidgid;
Set user and group for process.
You can set the MOJO_DAEMON_DEBUG environment variable to get some
advanced diagnostics information printed to STDERR.
MOJO_DAEMON_DEBUG=1
Mojolicious, Mojolicious::Guides, http://mojolicio.us.
| Mojolicious documentation | Contained in the Mojolicious distribution. |
package Mojo::Server::Daemon; use Mojo::Base 'Mojo::Server'; use Carp 'croak'; use File::Spec; use IO::File; use Mojo::Command; use Mojo::IOLoop; use Scalar::Util 'weaken'; use Sys::Hostname; # Bonjour use constant BONJOUR => $ENV{MOJO_NO_BONJOUR} ? 0 : eval 'use Net::Rendezvous::Publish 0.04 (); 1'; use constant DEBUG => $ENV{MOJO_DAEMON_DEBUG} || 0; has [qw/backlog group listen silent user/]; has ioloop => sub { Mojo::IOLoop->singleton }; has keep_alive_timeout => 5; has max_clients => 1000; has max_requests => 25; has websocket_timeout => 300; # Regex for listen sockets my $SOCKET_RE = qr/^ (http(?:s)?)\:\/\/ # Scheme (.+) # Host \:(\d+) # Port (?: \:(.*?) # Certificate \:(.*?) # Key (?:\:(.+)?)? # Certificate Authority )? $ /x; sub DESTROY { my $self = shift; # Cleanup connections return unless my $loop = $self->ioloop; my $cs = $self->{_cs} || {}; for my $id (keys %$cs) { $loop->drop($id) } # Cleanup listen sockets return unless my $listen = $self->{_listen}; for my $id (@$listen) { $loop->drop($id) } } sub prepare_ioloop { my $self = shift; # Listen my $loop = $self->ioloop; my $listen = $self->listen || ['http://*:3000']; $self->_listen($_) for @$listen; # Max clients $loop->max_connections($self->max_clients); } # "40 dollars!? This better be the best damn beer ever.. # *drinks beer* You got lucky." sub run { my $self = shift; # Prepare ioloop $self->prepare_ioloop; # User and group $self->setuidgid; # Signals $SIG{INT} = $SIG{TERM} = sub { exit 0 }; # Start loop $self->ioloop->start; } sub setuidgid { my $self = shift; # Group if (my $group = $self->group) { if (my $gid = (getgrnam($group))[2]) { # Switch undef $!; $) = $gid; croak qq/Can't switch to effective group "$group": $!/ if $!; } } # User if (my $user = $self->user) { if (my $uid = (getpwnam($user))[2]) { # Switch undef $!; $> = $uid; croak qq/Can't switch to effective user "$user": $!/ if $!; } } $self; } sub _build_tx { my ($self, $id, $c) = @_; # Build transaction my $tx = $self->on_transaction->($self); $tx->connection($id); # Identify $tx->res->headers->server('Mojolicious (Perl)'); # Store connection information my $loop = $self->ioloop; my $local = $loop->local_info($id); $tx->local_address($local->{address} || '127.0.0.1'); $tx->local_port($local->{port}); my $remote = $loop->remote_info($id); $tx->remote_address($remote->{address} || '127.0.0.1'); $tx->remote_port($remote->{port}); # TLS $tx->req->url->base->scheme('https') if $c->{tls}; # Handler callback weaken $self; $tx->on_request( sub { my $tx = shift; # Handler $self->on_request->($self, $tx); # Resume callback $tx->on_resume(sub { $self->_write($id) }); } ); # Upgrade callback $tx->on_upgrade(sub { $self->_upgrade($id, @_) }); # New request on the connection $c->{requests} ||= 0; $c->{requests}++; # Kept alive if we have more than one request on the connection $tx->kept_alive(1) if $c->{requests} > 1; $tx; } sub _close { my ($self, $loop, $id) = @_; $self->_drop($id); } sub _drop { my ($self, $id) = @_; # Finish gracefully my $c = $self->{_cs}->{$id}; if (my $tx = $c->{websocket} || $c->{transaction}) { $tx->server_close } # Drop connection delete $self->{_cs}->{$id}; } sub _error { my ($self, $loop, $id, $error) = @_; $self->app->log->error($error); $self->_drop($id); } sub _finish { my ($self, $id, $tx) = @_; # WebSocket if ($tx->is_websocket) { $self->_drop($id); return $self->ioloop->drop($id); } # Finish transaction my $c = $self->{_cs}->{$id}; delete $c->{transaction}; $tx->server_close; # WebSocket my $s = 0; if (my $ws = $c->{websocket}) { # Successful upgrade if ($ws->res->code eq '101') { # Make sure connection stays active $tx->keep_alive(1); # Upgrade connection timeout $self->ioloop->connection_timeout($id, $self->websocket_timeout); # Resume callback weaken $self; $ws->on_resume(sub { $self->_write($id) }); } # Failed upgrade else { delete $c->{websocket}; $ws->server_close; } } # Close connection if ($tx->req->error || !$tx->keep_alive) { $self->_drop($id); $self->ioloop->drop($id); } # Leftovers elsif (defined(my $leftovers = $tx->server_leftovers)) { $tx = $c->{transaction} = $self->_build_tx($id, $c); $tx->server_read($leftovers); } } sub _listen { my ($self, $listen) = @_; return unless $listen; # UNIX domain socket my $options = {}; my $tls; if ($listen =~ /^file\:\/\/(.+)$/) { unlink $options->{file} = $1 } # Internet socket elsif ($listen =~ $SOCKET_RE) { $tls = $options->{tls} = 1 if $1 eq 'https'; $options->{address} = $2 if $2 ne '*'; $options->{port} = $3; $options->{tls_cert} = $4 if $4; $options->{tls_key} = $5 if $5; $options->{tls_ca} = $6 if $6; } # Invalid else { croak qq/Invalid listen value "$listen"/ } # Listen backlog size my $backlog = $self->backlog; $options->{backlog} = $backlog if $backlog; # Callbacks weaken $self; $options->{on_accept} = sub { my ($loop, $id) = @_; # Add new connection $self->{_cs}->{$id} = {tls => $tls}; # Keep alive timeout $loop->connection_timeout($id => $self->keep_alive_timeout); }; $options->{on_close} = sub { $self->_close(@_) }; $options->{on_error} = sub { $self->_error(@_) }; $options->{on_read} = sub { $self->_read(@_) }; # Listen my $id = $self->ioloop->listen($options); $self->{_listen} ||= []; push @{$self->{_listen}}, $id; # Bonjour if (BONJOUR && (my $p = Net::Rendezvous::Publish->new)) { my $port = $options->{port}; my $name = $options->{address} || Sys::Hostname::hostname(); $p->publish( name => "Mojolicious ($name:$port)", type => '_http._tcp', domain => 'local', port => $port ) if $port && !$tls; } # Friendly message return if $self->silent; $self->app->log->info("Server listening ($listen)"); $listen =~ s/^(https?\:\/\/)\*/${1}127.0.0.1/i; print "Server available at $listen.\n"; } sub _read { my ($self, $loop, $id, $chunk) = @_; warn "< $chunk\n" if DEBUG; # Make sure we have a transaction my $c = $self->{_cs}->{$id}; my $tx = $c->{transaction} || $c->{websocket}; $tx = $c->{transaction} = $self->_build_tx($id, $c) unless $tx; # Parse chunk $tx->server_read($chunk); # Last keep alive request $tx->res->headers->connection('close') if ($c->{requests} || 0) >= $self->max_requests; # Finish if ($tx->is_done) { $self->_finish($id, $tx) } # Writing elsif ($tx->is_writing) { $self->_write($id) } } sub _upgrade { my ($self, $id, $tx) = @_; # WebSocket return unless $tx->req->headers->upgrade =~ /WebSocket/i; # WebSocket handshake handler my $c = $self->{_cs}->{$id}; my $ws = $c->{websocket} = $self->on_websocket->($self, $tx); # Not resumable yet $ws->on_resume(sub {1}); } sub _write { my ($self, $id) = @_; # Not writing my $c = $self->{_cs}->{$id}; return unless my $tx = $c->{transaction} || $c->{websocket}; return unless $tx->is_writing; # Get chunk my $chunk = $tx->server_write; # Callback weaken $self; my $cb = sub { $self->_write($id) }; # Done if ($tx->is_done) { $self->_finish($id, $tx); # No followup $cb = undef unless $c->{transaction} || $c->{websocket}; } # Not writing elsif (!$tx->is_writing) { $cb = undef } # Write $self->ioloop->write($id, $chunk, $cb); warn "> $chunk\n" if DEBUG; } 1; __END__