.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >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
.\"
.\" 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 "Proc::Guard 3pm"
.TH Proc::Guard 3pm "2021-01-09" "perl v5.32.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"
Proc::Guard \- process runner with RAII pattern
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Test::TCP qw/empty_port wait_port/;
\&    use File::Which qw/which/;
\&    use Proc::Guard;
\&
\&    my $port = empty_port();
\&    my $proc = proc_guard(scalar(which(\*(Aqmemcached\*(Aq)), \*(Aq\-p\*(Aq, $port);
\&    wait_port($port);
\&
\&    # your code here
\&
\&    # \-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&    # or, use perl code
\&    my $proc = proc_guard(sub {
\&        ... # run this code in child process
\&    });
\&    ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Proc::Guard runs process, and destroys it when the perl script exits.
.PP
This is useful for testing code working with server process.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "proc_guard(@cmdline|\e&code)" 4
.IX Item "proc_guard(@cmdline|&code)"
This is shorthand for:
.Sp
.Vb 3
\&    Proc::Guard\->new(
\&        command => \e@cmdline,
\&    );
.Ve
.Sp
or
.Sp
.Vb 3
\&    Proc::Guard\->new(
\&        code => \e&code,
\&    );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "my $proc = Proc::Guard\->new(%args);" 4
.el .IP "my \f(CW$proc\fR = Proc::Guard\->new(%args);" 4
.IX Item "my $proc = Proc::Guard->new(%args);"
Create and run a process. The process is terminated when the returned object is being DESTROYed.
.RS 4
.IP "command" 4
.IX Item "command"
.Vb 3
\&    Proc::Guard\->new(command => \*(Aq/path/to/memcached\*(Aq);
\&    # or
\&    Proc::Guard\->new(command => [\*(Aq/path/to/memcached\*(Aq, \*(Aq\-p\*(Aq, \*(Aq11211\*(Aq]);
.Ve
.Sp
The command line.
.IP "code" 4
.IX Item "code"
.Vb 1
\&    Proc::Guard\->new(code => sub { ... });
.Ve
.Sp
\&'code' or 'command' is required.
.IP "auto_start" 4
.IX Item "auto_start"
.Vb 1
\&    Proc::Guard\->new(auto_start => 0);
.Ve
.Sp
Start child process automatically or not(default: 1).
.RE
.RS 4
.RE
.IP "pid" 4
.IX Item "pid"
Returns process id (or undef if not running).
.IP "start" 4
.IX Item "start"
Starts process.
.IP "stop" 4
.IX Item "stop"
Stops process.
.SH "VARIABLES"
.IX Header "VARIABLES"
.ie n .IP "$Proc::Guard::EXIT_STATUS" 4
.el .IP "\f(CW$Proc::Guard::EXIT_STATUS\fR" 4
.IX Item "$Proc::Guard::EXIT_STATUS"
The last exit status code by \f(CW\*(C`$proc\->stop\*(C'\fR.  If \f(CW\*(C`waitpid\*(C'\fR
failed with an error, this will be set to \f(CW\*(C`undef\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tokuhiro Matsuno <tokuhirom \s-1AAJKLFJEF GMAIL COM\s0>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) Tokuhiro Matsuno
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.