.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojo::Server 3pm"
.TH Mojo::Server 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mojo::Server \- HTTP/WebSocket server base class
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  package Mojo::Server::MyServer;
\&  use Mojo::Base \*(AqMojo::Server\*(Aq, \-signatures;
\&
\&  sub run ($self) {
\&
\&    # Get a transaction
\&    my $tx = $self\->build_tx;
\&
\&    # Emit "request" event
\&    $self\->emit(request => $tx);
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mojo::Server is an abstract base class for HTTP/WebSocket servers and server interfaces, like Mojo::Server::CGI,
Mojo::Server::Daemon, Mojo::Server::Hypnotoad, Mojo::Server::Morbo, Mojo::Server::Prefork and
Mojo::Server::PSGI.
.SH EVENTS
.IX Header "EVENTS"
Mojo::Server inherits all events from Mojo::EventEmitter and can emit the following new ones.
.SS request
.IX Subsection "request"
.Vb 1
\&  $server\->on(request => sub ($server, $tx) {...});
.Ve
.PP
Emitted when a request is ready and needs to be handled.
.PP
.Vb 6
\&  $server\->on(request => sub ($server, $tx) {
\&    $tx\->res\->code(200);
\&    $tx\->res\->headers\->content_type(\*(Aqtext/plain\*(Aq);
\&    $tx\->res\->body(\*(AqHello World!\*(Aq);
\&    $tx\->resume;
\&  });
.Ve
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
Mojo::Server implements the following attributes.
.SS app
.IX Subsection "app"
.Vb 2
\&  my $app = $server\->app;
\&  $server = $server\->app(MojoSubclass\->new);
.Ve
.PP
Application this server handles, defaults to a Mojo::HelloWorld object.
.SS reverse_proxy
.IX Subsection "reverse_proxy"
.Vb 2
\&  my $bool = $server\->reverse_proxy;
\&  $server  = $server\->reverse_proxy($bool);
.Ve
.PP
This server operates behind a reverse proxy, defaults to the value of the \f(CW\*(C`MOJO_REVERSE_PROXY\*(C'\fR environment variable
or true if "trusted_proxies" is not empty.
.SS trusted_proxies
.IX Subsection "trusted_proxies"
.Vb 2
\&  my $proxies = $server\->trusted_proxies;
\&  $server     = $server\->trusted_proxies([\*(Aq10.0.0.0/8\*(Aq, \*(Aq127.0.0.1\*(Aq, \*(Aq172.16.0.0/12\*(Aq, \*(Aq192.168.0.0/16\*(Aq, \*(Aqfc00::/7\*(Aq]);
.Ve
.PP
This server expects requests from trusted reverse proxies, defaults to the value of the \f(CW\*(C`MOJO_TRUSTED_PROXIES\*(C'\fR
environment variable split on commas with optional whitespace. These proxies should be addresses or networks in CIDR
form.
.SH METHODS
.IX Header "METHODS"
Mojo::Server inherits all methods from Mojo::EventEmitter and implements the following new ones.
.SS build_app
.IX Subsection "build_app"
.Vb 3
\&  my $app = $server\->build_app(\*(AqMyApp\*(Aq);
\&  my $app = $server\->build_app(\*(AqMyApp\*(Aq, log => Mojo::Log\->new);
\&  my $app = $server\->build_app(\*(AqMyApp\*(Aq, {log => Mojo::Log\->new});
.Ve
.PP
Build application from class and assign it to "app".
.SS build_tx
.IX Subsection "build_tx"
.Vb 1
\&  my $tx = $server\->build_tx;
.Ve
.PP
Let application build a transaction.
.SS daemonize
.IX Subsection "daemonize"
.Vb 1
\&  $server\->daemonize;
.Ve
.PP
Daemonize server process.
.SS load_app
.IX Subsection "load_app"
.Vb 3
\&  my $app = $server\->load_app(\*(Aq/home/sri/myapp.pl\*(Aq);
\&  my $app = $server\->load_app(\*(Aq/home/sri/myapp.pl\*(Aq, log => Mojo::Log\->new);
\&  my $app = $server\->load_app(\*(Aq/home/sri/myapp.pl\*(Aq, {log => Mojo::Log\->new});
.Ve
.PP
Load application from script and assign it to "app".
.PP
.Vb 1
\&  say Mojo::Server\->new\->load_app(\*(Aq./myapp.pl\*(Aq)\->home;
.Ve
.SS new
.IX Subsection "new"
.Vb 3
\&  my $server = Mojo::Server\->new;
\&  my $server = Mojo::Server\->new(reverse_proxy => 1);
\&  my $server = Mojo::Server\->new({reverse_proxy => 1});
.Ve
.PP
Construct a new Mojo::Server object and subscribe to "request" event with default request handling.
.SS run
.IX Subsection "run"
.Vb 1
\&  $server\->run;
.Ve
.PP
Run server. Meant to be overloaded in a subclass.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.