.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Child::Link::Proc 3pm"
.TH Child::Link::Proc 3pm "2022-10-13" "perl v5.34.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"
Child::Link::Proc \- Proc object used by Child.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This class inherits from:
.IP "Child::Link" 4
.IX Item "Child::Link"
.SH "METHODS"
.IX Header "METHODS"
.PD 0
.ie n .IP "$bool = $proc\->\fBis_complete()\fR" 4
.el .IP "\f(CW$bool\fR = \f(CW$proc\fR\->\fBis_complete()\fR" 4
.IX Item "$bool = $proc->is_complete()"
.PD
Check if the child is finished (non-blocking)
.ie n .IP "$proc\->\fBwait()\fR" 4
.el .IP "\f(CW$proc\fR\->\fBwait()\fR" 4
.IX Item "$proc->wait()"
Wait until child terminates, destroy remaining zombie process (blocking)
.ie n .IP "$proc\->kill($SIG)" 4
.el .IP "\f(CW$proc\fR\->kill($SIG)" 4
.IX Item "$proc->kill($SIG)"
Send the \f(CW$SIG\fR signal to the child process.
.Sp
\&\fB\s-1NOTE\s0\fR: \fBkill()\fR is unpredictable on windows, strawberry perl sends the kill
signal to the parent as well as the child.
.ie n .IP "$proc\->\fBpid()\fR" 4
.el .IP "\f(CW$proc\fR\->\fBpid()\fR" 4
.IX Item "$proc->pid()"
Returns the process \s-1PID.\s0
.ie n .IP "$proc\->\fBexit_status()\fR" 4
.el .IP "\f(CW$proc\fR\->\fBexit_status()\fR" 4
.IX Item "$proc->exit_status()"
Will be undef unless the process has exited, otherwise it will have the exit
status.
.Sp
\&\fBNote\fR: When you call exit($N) the actual unix exit status will be bit shifted
with extra information added. \fBexit_status()\fR will shift the value back for you.
That means \fBexit_status()\fR will return 2 when your child calls \fBexit\fR\|(2) see
\&\fBunix_exit()\fR if you want the actual value \fBwait()\fR assigned to $?.
.ie n .IP "$proc\->\fBunix_exit()\fR" 4
.el .IP "\f(CW$proc\fR\->\fBunix_exit()\fR" 4
.IX Item "$proc->unix_exit()"
When you call exit($N) the actual unix exit status will be bit shifted
with extra information added. See \fBexit_status()\fR if you want the actual value
used in \fBexit()\fR in the child.
.SH "HISTORY"
.IX Header "HISTORY"
Most of this was part of Parallel::Runner intended for use in the Fennec
project. Fennec is being broken into multiple parts, this is one such part.
.SH "FENNEC PROJECT"
.IX Header "FENNEC PROJECT"
This module is part of the Fennec project. See Fennec for more details.
Fennec is a project to develop an extendable and powerful testing framework.
Together the tools that make up the Fennec framework provide a potent testing
environment.
.PP
The tools provided by Fennec are also useful on their own. Sometimes a tool
created for Fennec is useful outside the greater framework. Such tools are
turned into their own projects. This is one such project.
.IP "Fennec \- The core framework" 2
.IX Item "Fennec - The core framework"
The primary Fennec project that ties them all together.
.SH "AUTHORS"
.IX Header "AUTHORS"
Chad Granum exodist7@gmail.com
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2010 Chad Granum
.PP
Child is free software; Standard perl licence.
.PP
Child is distributed in the hope that it will be useful, but \s-1WITHOUT
ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS
FOR A PARTICULAR PURPOSE.\s0  See the license for more details.