.\" -*- 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 "Web::Machine::FSM 3pm"
.TH Web::Machine::FSM 3pm 2024-03-08 "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
Web::Machine::FSM \- The State Machine runner
.SH VERSION
.IX Header "VERSION"
version 0.17
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Web::Machine::FSM;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is the heart of the Web::Machine, this is the thing
which runs the state machine whose states are contained in the
Web::Machine::FSM::States module.
.SH METHODS
.IX Header "METHODS"
.ie n .IP """new ( %params )""" 4
.el .IP "\f(CWnew ( %params )\fR" 4
.IX Item "new ( %params )"
This accepts two \f(CW%params\fR, the first is a boolean to
indicate if you should turn on tracing or not, and the second
is optional name of the HTTP header in which to place the
tracing information.
.ie n .IP """tracing""" 4
.el .IP \f(CWtracing\fR 4
.IX Item "tracing"
Are we tracing or not?
.ie n .IP """tracing_header""" 4
.el .IP \f(CWtracing_header\fR 4
.IX Item "tracing_header"
Accessor for the HTTP header name to store tracing data in.
This default to \f(CW\*(C`X\-Web\-Machine\-Trace\*(C'\fR.
.ie n .IP """run ( $resource )""" 4
.el .IP "\f(CWrun ( $resource )\fR" 4
.IX Item "run ( $resource )"
Given a Web::Machine::Resource instance, this will execute
the state machine.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Web Machine state diagram <https://github.com/Webmachine/webmachine/wiki/Diagram>" 4
.IX Item "Web Machine state diagram <https://github.com/Webmachine/webmachine/wiki/Diagram>"
.SH SUPPORT
.IX Header "SUPPORT"
bugs may be submitted through <https://github.com/houseabsolute/webmachine\-perl/issues>.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Stevan Little <stevan@cpan.org>
.IP \(bu 4
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2016 by Infinity Interactive, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.