.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Message::Passing::Role::Script 3pm"
.TH Message::Passing::Role::Script 3pm "2013-04-23" "perl v5.18.1" "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"
Message::Passing:Role::Script \- Handy role for building messaging scripts.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    # my_message_passer.pl
\&    package My::Message::Passer;
\&    use Moo;
\&    use MooX::Options;
\&    use MooX::Types::MooseLike::Base qw/ Bool /;
\&    use Message::Passing::DSL;
\&
\&    with \*(AqMessage::Passing::Role::Script\*(Aq;
\&
\&    option foo => (
\&        is => \*(Aqro\*(Aq,
\&        isa => Bool,
\&    );
\&
\&    sub build_chain {
\&        my $self = shift;
\&        message_chain {
\&            input example => ( output_to => \*(Aqtest_out\*(Aq, .... );
\&            output test_out => ( foo => $self\->foo, ... );
\&        };
\&    }
\&
\&    _\|_PACKAGE_\|_\->start unless caller;
\&    1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This role can be used to make simple message passing scripts.
.PP
The user implements a MooX::Options type script class, with a
\&\f(CW\*(C`build_chain\*(C'\fR method, that builds one or more
Message::Passing chains and returns them.
.PP
.Vb 1
\&    _\|_PACKAGE_\|_\->start unless caller;
.Ve
.PP
is then used before the end of the script.
.PP
This means that when the code is run as a script, it'll parse
the command line options, and start a message passing server..
.SH "REQUIRED METHODS"
.IX Header "REQUIRED METHODS"
.SH "build_chain"
.IX Header "build_chain"
Return a chain of message processors, or an array reference with
multiple chains of message processors.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "daemonize"
.IX Subsection "daemonize"
Do a double fork and lose controlling terminal.
.PP
Used to run scripts in the background.
.SS "io_priority"
.IX Subsection "io_priority"
The \s-1IO\s0 priority to run the script at..
.PP
Valid values for the \s-1IO\s0 priority are:
.IP "none" 4
.IX Item "none"
.PD 0
.IP "be" 4
.IX Item "be"
.IP "rt" 4
.IX Item "rt"
.IP "idle" 4
.IX Item "idle"
.PD
.SS "user"
.IX Subsection "user"
Changes the user the script is running as. You probably need to run the script as root for this option to work.
.SS "pid_file"
.IX Subsection "pid_file"
Write a pid file out. Useful for running Message::Passing scripts as daemons and/or from init.d scripts.
.SH "METHODS"
.IX Header "METHODS"
.SS "start"
.IX Subsection "start"
Called as a class method, it will build the current class as a
command line script (parsing \s-1ARGV\s0), setup the daemonization options,
call the \->build_chain method supplied by the user to build the
chains needed for this application.
.PP
Then enters the event loop and never returns.
.SS "change_uid_if_needed"
.IX Subsection "change_uid_if_needed"
Tries to change uid if the \-\-user option has been supplied
.SS "deamonize_if_needed"
.IX Subsection "deamonize_if_needed"
Tires to daemonize if the \-\-daemonize option has been supplied
.SS "set_io_priority_if_needed"
.IX Subsection "set_io_priority_if_needed"
Tries to set the process' \s-1IO\s0 priority if the \-\-io_priority option
has been supplied.
.SH "SPONSORSHIP"
.IX Header "SPONSORSHIP"
This module exists due to the wonderful people at Suretec Systems Ltd.
<http://www.suretecsystems.com/> who sponsored its development for its
VoIP division called SureVoIP <http://www.surevoip.co.uk/> for use with
the SureVoIP \s-1API \-\s0
<http://www.surevoip.co.uk/support/wiki/api_documentation>
.SH "AUTHOR, COPYRIGHT AND LICENSE"
.IX Header "AUTHOR, COPYRIGHT AND LICENSE"
See Message::Passing.