.\" -*- 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 "Feersum::Runner 3pm"
.TH Feersum::Runner 3pm 2024-03-07 "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
Feersum::Runner \- feersum script core
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 8
\&    use Feersum::Runner;
\&    my $runner = Feersum::Runner\->new(
\&        listen => \*(Aqlocalhost:5000\*(Aq,
\&        pre_fork => 0,
\&        quiet => 1,
\&        app_file => \*(Aqapp.feersum\*(Aq,
\&    );
\&    $runner\->run($feersum_app);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Much like Plack::Runner, but with far fewer options.
.SH METHODS
.IX Header "METHODS"
.ie n .IP """Feersum::Runner\->new(%params)""" 4
.el .IP \f(CWFeersum::Runner\->new(%params)\fR 4
.IX Item "Feersum::Runner->new(%params)"
Returns a Feersum::Runner singleton.  Params are only applied for the first
invocation.
.RS 4
.IP listen 8
.IX Item "listen"
Listen on this TCP socket (\f(CW\*(C`host:port\*(C'\fR format).
.IP pre_fork 8
.IX Item "pre_fork"
Fork this many worker processes.
.Sp
The fork is run immediately at startup and after the app is loaded (i.e. in
the \f(CWrun()\fR method).
.IP quiet 8
.IX Item "quiet"
Don't be so noisy. (default: on)
.IP app_file 8
.IX Item "app_file"
Load this filename as a native feersum app.
.RE
.RS 4
.RE
.ie n .IP """$runner\->run($feersum_app)""" 4
.el .IP \f(CW$runner\->run($feersum_app)\fR 4
.IX Item "$runner->run($feersum_app)"
Run Feersum with the specified app code reference.  Note that this is not a
PSGI app, but a native Feersum app.
.ie n .IP """$runner\->assign_request_handler($subref)""" 4
.el .IP \f(CW$runner\->assign_request_handler($subref)\fR 4
.IX Item "$runner->assign_request_handler($subref)"
For sub-classes to override, assigns an app handler. (e.g.
Plack::Handler::Feersum).  By default, this assigns a Feersum-native (and
not PSGI) handler.
.ie n .IP """$runner\->quit()""" 4
.el .IP \f(CW$runner\->quit()\fR 4
.IX Item "$runner->quit()"
Initiate a graceful shutdown.  A signal handler for SIGQUIT will call this
method.
.SH AUTHOR
.IX Header "AUTHOR"
Jeremy Stashewsky, \f(CW\*(C`stash@cpan.org\*(C'\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2010 by Jeremy Stashewsky & Socialtext Inc.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.7 or,
at your option, any later version of Perl 5 you may have available.