.\" -*- 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 "HTTP::Server::Simple 3"
.TH HTTP::Server::Simple 3 2023-07-25 "perl v5.38.0" "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
HTTP::Server::Simple \- Lightweight HTTP server
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use warnings;
\& use strict;
\& 
\& use HTTP::Server::Simple;
\& 
\& my $server = HTTP::Server::Simple\->new();
\& $server\->run();
.Ve
.PP
However, normally you will sub-class the HTTP::Server::Simple::CGI
module (see HTTP::Server::Simple::CGI);
.PP
.Vb 2
\& package Your::Web::Server;
\& use base qw(HTTP::Server::Simple::CGI);
\& 
\& sub handle_request {
\&     my ($self, $cgi) = @_;
\&
\&     #... do something, print output to default
\&     # selected filehandle...
\&
\& }
\& 
\& 1;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a simple standalone HTTP server. By default, it doesn't thread
or fork. It does, however, act as a simple frontend which can be used
to build a standalone web-based application or turn a CGI into one.
.PP
It is possible to use Net::Server classes to create forking,
pre-forking, and other types of more complicated servers; see
"net_server".
.PP
By default, the server traps a few signals:
.IP HUP 4
.IX Item "HUP"
When you \f(CW\*(C`kill \-HUP\*(C'\fR the server, it lets the current request finish being
processed, then uses the \f(CW\*(C`restart\*(C'\fR method to re-exec itself. Please note that
in order to provide restart-on-SIGHUP, HTTP::Server::Simple sets a SIGHUP
handler during initialisation. If your request handling code forks you need to
make sure you reset this or unexpected things will happen if somebody sends a
HUP to all running processes spawned by your app (e.g. by "kill \-HUP <script>")
.IP PIPE 4
.IX Item "PIPE"
If the server detects a broken pipe while writing output to the client, 
it ignores the signal. Otherwise, a client closing the connection early 
could kill the server.
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 3
\& #!/usr/bin/perl
\& {
\& package MyWebServer;
\& 
\& use HTTP::Server::Simple::CGI;
\& use base qw(HTTP::Server::Simple::CGI);
\& 
\& my %dispatch = (
\&     \*(Aq/hello\*(Aq => \e&resp_hello,
\&     # ...
\& );
\& 
\& sub handle_request {
\&     my $self = shift;
\&     my $cgi  = shift;
\&   
\&     my $path = $cgi\->path_info();
\&     my $handler = $dispatch{$path};
\& 
\&     if (ref($handler) eq "CODE") {
\&         print "HTTP/1.0 200 OK\er\en";
\&         $handler\->($cgi);
\&         
\&     } else {
\&         print "HTTP/1.0 404 Not found\er\en";
\&         print $cgi\->header,
\&               $cgi\->start_html(\*(AqNot found\*(Aq),
\&               $cgi\->h1(\*(AqNot found\*(Aq),
\&               $cgi\->end_html;
\&     }
\& }
\& 
\& sub resp_hello {
\&     my $cgi  = shift;   # CGI.pm object
\&     return if !ref $cgi;
\&     
\&     my $who = $cgi\->param(\*(Aqname\*(Aq);
\&     
\&     print $cgi\->header,
\&           $cgi\->start_html("Hello"),
\&           $cgi\->h1("Hello $who!"),
\&           $cgi\->end_html;
\& }
\& 
\& } 
\& 
\& # start the server on port 8080
\& my $pid = MyWebServer\->new(8080)\->background();
\& print "Use \*(Aqkill $pid\*(Aq to stop server.\en";
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "HTTP::Server::Simple\->new($port, $family)"
.el .SS "HTTP::Server::Simple\->new($port, \f(CW$family\fP)"
.IX Subsection "HTTP::Server::Simple->new($port, $family)"
API call to start a new server.  Does not actually start listening
until you call \f(CW\*(C`\->run()\*(C'\fR.  If omitted, \f(CW$port\fR defaults to 8080,
and \f(CW$family\fR defaults to Socket::AF_INET.
The alternative domain is Socket::AF_INET6.
.SS lookup_localhost
.IX Subsection "lookup_localhost"
Looks up the local host's IP address, and returns it.  For most hosts,
this is \f(CW127.0.0.1\fR, or possibly \f(CW\*(C`::1\*(C'\fR.
.SS "port [NUMBER]"
.IX Subsection "port [NUMBER]"
Takes an optional port number for this server to listen on.
.PP
Returns this server's port. (Defaults to 8080)
.SS "family [NUMBER]"
.IX Subsection "family [NUMBER]"
Takes an optional address family for this server to use.  Valid values
are Socket::AF_INET and Socket::AF_INET6.  All other values are silently
changed into Socket::AF_INET for backwards compatibility with previous
versions of the module.
.PP
Returns the address family of the present listening socket.  (Defaults to
Socket::AF_INET.)
.SS "host [address]"
.IX Subsection "host [address]"
Takes an optional host address for this server to bind to.
.PP
Returns this server's bound address (if any).  Defaults to \f(CW\*(C`undef\*(C'\fR
(bind to all interfaces).
.SS "background [ARGUMENTS]"
.IX Subsection "background [ARGUMENTS]"
Runs the server in the background, and returns the process ID of the
started process.  Any arguments will be passed through to "run".
.SS "run [ARGUMENTS]"
.IX Subsection "run [ARGUMENTS]"
Run the server.  If all goes well, this won't ever return, but it will
start listening for \f(CW\*(C`HTTP\*(C'\fR requests.  Any arguments passed to this
will be passed on to the underlying Net::Server implementation, if
one is used (see "net_server").
.SS net_server
.IX Subsection "net_server"
User-overridable method. If you set it to a Net::Server subclass,
that subclass is used for the \f(CW\*(C`run\*(C'\fR method.  Otherwise, a minimal
implementation is used as default.
.SS restart
.IX Subsection "restart"
Restarts the server. Usually called by a HUP signal, not directly.
.SS "stdio_handle [FILEHANDLE]"
.IX Subsection "stdio_handle [FILEHANDLE]"
When called with an argument, sets the socket to the server to that arg.
.PP
Returns the socket to the server; you should only use this for actual socket-related
calls like \f(CW\*(C`getsockname\*(C'\fR.  If all you want is to read or write to the socket,
you should use \f(CW\*(C`stdin_handle\*(C'\fR and \f(CW\*(C`stdout_handle\*(C'\fR to get the in and out filehandles
explicitly.
.SS stdin_handle
.IX Subsection "stdin_handle"
Returns a filehandle used for input from the client.  By default,
returns whatever was set with \f(CW\*(C`stdio_handle\*(C'\fR, but a subclass could do
something interesting here.
.SS stdout_handle
.IX Subsection "stdout_handle"
Returns a filehandle used for output to the client.  By default, 
returns whatever was set with \f(CW\*(C`stdio_handle\*(C'\fR, but a subclass
could do something interesting here.
.SH "IMPORTANT SUB-CLASS METHODS"
.IX Header "IMPORTANT SUB-CLASS METHODS"
A selection of these methods should be provided by sub-classes of this
module.
.SS handler
.IX Subsection "handler"
This method is called after setup, with no parameters.  It should
print a valid, \fIfull\fR HTTP response to the default selected
filehandle.
.ie n .SS "setup(name => $value, ...)"
.el .SS "setup(name => \f(CW$value\fP, ...)"
.IX Subsection "setup(name => $value, ...)"
This method is called with a name => value list of various things
to do with the request.  This list is given below.
.PP
The default setup handler simply tries to call methods with the names
of keys of this list.
.PP
.Vb 12
\&  ITEM/METHOD   Set to                Example
\&  \-\-\-\-\-\-\-\-\-\-\-  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-    \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&  method       Request Method        "GET", "POST", "HEAD"
\&  protocol     HTTP version          "HTTP/1.1"
\&  request_uri  Complete Request URI  "/foobar/baz?foo=bar"
\&  path         Path part of URI      "/foobar/baz"
\&  query_string Query String          undef, "foo=bar"
\&  port         Received Port         80, 8080
\&  peername     Remote name           "200.2.4.5", "foo.com"
\&  peeraddr     Remote address        "200.2.4.5", "::1"
\&  peerport     Remote port           42424
\&  localname    Local interface       "localhost", "myhost.com"
.Ve
.ie n .SS "headers([Header => $value, ...])"
.el .SS "headers([Header => \f(CW$value\fP, ...])"
.IX Subsection "headers([Header => $value, ...])"
Receives HTTP headers and does something useful with them.  This is
called by the default \f(CWsetup()\fR method.
.PP
You have lots of options when it comes to how you receive headers.
.PP
You can, if you really want, define \f(CWparse_headers()\fR and parse them
raw yourself.
.PP
Secondly, you can intercept them very slightly cooked via the
\&\f(CWsetup()\fR method, above.
.PP
Thirdly, you can leave the \f(CWsetup()\fR header as-is (or calling the
superclass \f(CWsetup()\fR for unknown request items).  Then you can define
\&\f(CWheaders()\fR in your sub-class and receive them all at once.
.PP
Finally, you can define handlers to receive individual HTTP headers.
This can be useful for very simple SOAP servers (to name a
crack-fueled standard that defines its own special HTTP headers).
.PP
To do so, you'll want to define the \f(CWheader()\fR method in your subclass.
That method will be handed a (key,value) pair of the header name and the value.
.SS accept_hook
.IX Subsection "accept_hook"
If defined by a sub-class, this method is called directly after an
accept happens.  An accept_hook to add SSL support might look like this:
.PP
.Vb 3
\&    sub accept_hook {
\&        my $self = shift;
\&        my $fh   = $self\->stdio_handle;
\&
\&        $self\->SUPER::accept_hook(@_);
\&
\&        my $newfh =
\&        IO::Socket::SSL\->start_SSL( $fh, 
\&            SSL_server    => 1,
\&            SSL_use_cert  => 1,
\&            SSL_cert_file => \*(Aqmyserver.crt\*(Aq,
\&            SSL_key_file  => \*(Aqmyserver.key\*(Aq,
\&        )
\&        or warn "problem setting up SSL socket: " . IO::Socket::SSL::errstr();
\&
\&        $self\->stdio_handle($newfh) if $newfh;
\&    }
.Ve
.SS post_setup_hook
.IX Subsection "post_setup_hook"
If defined by a sub-class, this method is called after all setup has
finished, before the handler method.
.SS print_banner
.IX Subsection "print_banner"
This routine prints a banner before the server request-handling loop
starts.
.PP
Methods below this point are probably not terribly useful to define
yourself in subclasses.
.SS parse_request
.IX Subsection "parse_request"
Parse the HTTP request line.  Returns three values, the request
method, request URI and the protocol.
.SS parse_headers
.IX Subsection "parse_headers"
Parses incoming HTTP headers from STDIN, and returns an arrayref of
\&\f(CW\*(C`(header => value)\*(C'\fR pairs.  See "headers" for possibilities on
how to inspect headers.
.SS setup_listener
.IX Subsection "setup_listener"
This routine binds the server to a port and interface.
.SS after_setup_listener
.IX Subsection "after_setup_listener"
This method is called immediately after setup_listener. It's here just
for you to override.
.SS bad_request
.IX Subsection "bad_request"
This method should print a valid HTTP response that says that the
request was invalid.
.SS valid_http_method($method)
.IX Subsection "valid_http_method($method)"
Given a candidate HTTP method in \f(CW$method\fR, determine if it is valid.
Override if, for example, you'd like to do some WebDAV.  The default
implementation only accepts \f(CW\*(C`GET\*(C'\fR, \f(CW\*(C`POST\*(C'\fR, \f(CW\*(C`HEAD\*(C'\fR, \f(CW\*(C`PUT\*(C'\fR, \f(CW\*(C`PATCH\*(C'\fR,
\&\f(CW\*(C`DELETE\*(C'\fR and \f(CW\*(C`OPTIONS\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Best Practical Solutions, LLC <modules@bestpractical.com>
.SH CONTRIBUTORS
.IX Header "CONTRIBUTORS"
Jesse Vincent, <jesse@bestpractical.com>. Original author.
.PP
Marcus Ramberg <drave@thefeed.no> contributed tests, cleanup, etc
.PP
Sam Vilain, <samv@cpan.org> contributed the CGI.pm split-out and
header/setup API.
.PP
Example section by almut on perlmonks, suggested by Mark Fuller.
.SH BUGS
.IX Header "BUGS"
There certainly are some. Please report them via rt.cpan.org
.SH LICENSE
.IX Header "LICENSE"
This software is Copyright (c) 2004\-2015 Best Practical Solutions
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.