NAME¶
Mojo::Server::Prefork - Preforking non-blocking I/O HTTP and WebSocket server
SYNOPSIS¶
use Mojo::Server::Prefork;
my $prefork = Mojo::Server::Prefork->new(listen => ['http://*:8080']);
$prefork->unsubscribe('request');
$prefork->on(request => sub {
my ($prefork, $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;
});
$prefork->run;
DESCRIPTION¶
Mojo::Server::Prefork is a full featured, UNIX optimized, preforking
non-blocking I/O HTTP and WebSocket server, built around the very well tested
and reliable Mojo::Server::Daemon, with "IPv6", "TLS",
"Comet" (long polling), "keep-alive", connection pooling,
timeout, cookie, multipart and multiple event loop support. Note that the
server uses signals for process management, so you should avoid modifying
signal handlers in your applications.
Optional modules EV (4.0+), IO::Socket::IP (0.16+) and IO::Socket::SSL (1.75+)
are supported transparently through Mojo::IOLoop, and used if installed.
Individual features can also be disabled with the MOJO_NO_IPV6 and MOJO_NO_TLS
environment variables.
See Mojolicious::Guides::Cookbook for more.
SIGNALS¶
Mojo::Server::Prefork can be controlled at runtime with the following signals.
Manager¶
- INT, TERM
- Shutdown server immediately.
- QUIT
- Shutdown server gracefully.
- TTIN
- Increase worker pool by one.
- TTOU
- Decrease worker pool by one.
Worker¶
- INT, TERM
- Stop worker immediately.
- QUIT
- Stop worker gracefully.
EVENTS¶
Mojo::Server::Prefork inherits all events from Mojo::Server::Daemon and can emit
the following new ones.
finish¶
$prefork->on(finish => sub {
my ($prefork, $graceful) = @_;
...
});
Emitted when the server shuts down.
$prefork->on(finish => sub {
my ($prefork, $graceful) = @_;
say $graceful ? 'Graceful server shutdown' : 'Server shutdown';
});
heartbeat¶
$prefork->on(heartbeat => sub {
my ($prefork, $pid) = @_;
...
});
Emitted when a heartbeat message has been received from a worker.
$prefork->on(heartbeat => sub {
my ($prefork, $pid) = @_;
say "Worker $pid has a heartbeat";
});
reap¶
$prefork->on(reap => sub {
my ($prefork, $pid) = @_;
...
});
Emitted when a child process dies.
$prefork->on(reap => sub {
my ($prefork, $pid) = @_;
say "Worker $pid stopped";
});
spawn¶
$prefork->on(spawn => sub {
my ($prefork, $pid) = @_;
...
});
Emitted when a worker process is spawned.
$prefork->on(spawn => sub {
my ($prefork, $pid) = @_;
say "Worker $pid started";
});
wait¶
$prefork->on(wait => sub {
my $prefork = shift;
...
});
Emitted when the manager starts waiting for new heartbeat messages.
$prefork->on(wait => sub {
my $prefork = shift;
my $workers = $prefork->workers;
say "Waiting for heartbeat messages from $workers workers";
});
ATTRIBUTES¶
Mojo::Server::Prefork inherits all attributes from Mojo::Server::Daemon and
implements the following new ones.
accept_interval¶
my $interval = $prefork->accept_interval;
$prefork = $prefork->accept_interval(0.5);
Interval in seconds for trying to reacquire the accept mutex and connection
management, defaults to 0.025. Note that changing this value can affect
performance and idle CPU usage.
accepts¶
my $accepts = $prefork->accepts;
$prefork = $prefork->accepts(100);
Maximum number of connections a worker is allowed to accept before stopping
gracefully, defaults to 1000. Setting the value to 0 will allow workers to
accept new connections indefinitely. Note that up to half of this value can be
subtracted randomly to improve load balancing, and that worker processes will
stop sending heartbeat messages once the limit has been reached.
graceful_timeout¶
my $timeout = $prefork->graceful_timeout;
$prefork = $prefork->graceful_timeout(15);
Maximum amount of time in seconds stopping a worker gracefully may take before
being forced, defaults to 20.
heartbeat_interval¶
my $interval = $prefork->heartbeat_intrval;
$prefork = $prefork->heartbeat_interval(3);
Heartbeat interval in seconds, defaults to 5.
heartbeat_timeout¶
my $timeout = $prefork->heartbeat_timeout;
$prefork = $prefork->heartbeat_timeout(2);
Maximum amount of time in seconds before a worker without a heartbeat will be
stopped gracefully, defaults to 20.
lock_file¶
my $file = $prefork->lock_file;
$prefork = $prefork->lock_file('/tmp/prefork.lock');
Full path of accept mutex lock file prefix, to which the process id will be
appended, defaults to a random temporary path.
lock_timeout¶
my $timeout = $prefork->lock_timeout;
$prefork = $prefork->lock_timeout(1);
Maximum amount of time in seconds a worker may block when waiting for the accept
mutex, defaults to 0.5.
multi_accept¶
my $multi = $prefork->multi_accept;
$prefork = $prefork->multi_accept(100);
Number of connections to accept at once, defaults to 50.
pid_file¶
my $file = $prefork->pid_file;
$prefork = $prefork->pid_file('/tmp/prefork.pid');
Full path of process id file, defaults to a random temporary path.
workers¶
my $workers = $prefork->workers;
$prefork = $prefork->workers(10);
Number of worker processes, defaults to 4. A good rule of thumb is two worker
processes per CPU core.
METHODS¶
Mojo::Server::Prefork inherits all methods from Mojo::Server::Daemon and
implements the following new ones.
check_pid¶
my $pid = $prefork->check_pid;
Get process id for running server from "pid_file" or delete it if
server is not running.
say 'Server is not running' unless $prefork->check_pid;
run¶
$prefork->run;
Run server.
SEE ALSO¶
Mojolicious, Mojolicious::Guides, <
http://mojolicio.us>.