.\" 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::IPC 3pm" .TH Child::Link::IPC 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::IPC \- Base class for process links that provide IPC. .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 "$proc\->new( $pid. @shared )" 4 .el .IP "\f(CW$proc\fR\->new( \f(CW$pid\fR. \f(CW@shared\fR )" 4 .IX Item "$proc->new( $pid. @shared )" .PD Constructor .ie n .IP "$proc\->\fBread()\fR" 4 .el .IP "\f(CW$proc\fR\->\fBread()\fR" 4 .IX Item "$proc->read()" Read a message from the child. .ie n .IP "$proc\->write( @MESSAGES )" 4 .el .IP "\f(CW$proc\fR\->write( \f(CW@MESSAGES\fR )" 4 .IX Item "$proc->write( @MESSAGES )" Send the messages to the child. works like print, you must add \*(L"\en\*(R". .ie n .IP "$proc\->say( @MESSAGES )" 4 .el .IP "\f(CW$proc\fR\->say( \f(CW@MESSAGES\fR )" 4 .IX Item "$proc->say( @MESSAGES )" Send the messages to the child. works like say, adds the separator for you (usually \*(L"\en\*(R"). .ie n .IP "$proc\->autoflush( $BOOL )" 4 .el .IP "\f(CW$proc\fR\->autoflush( \f(CW$BOOL\fR )" 4 .IX Item "$proc->autoflush( $BOOL )" Turn autoflush on/off for the current processes write handle. This is on by default. .ie n .IP "$proc\->\fBflush()\fR" 4 .el .IP "\f(CW$proc\fR\->\fBflush()\fR" 4 .IX Item "$proc->flush()" Flush the current processes write handle. .ie n .IP "$proc\->\fBipc()\fR" 4 .el .IP "\f(CW$proc\fR\->\fBipc()\fR" 4 .IX Item "$proc->ipc()" .PD 0 .ie n .IP "$proc\->_ipc( $new )" 4 .el .IP "\f(CW$proc\fR\->_ipc( \f(CW$new\fR )" 4 .IX Item "$proc->_ipc( $new )" .PD Accessors for you to use or ignore. .SH "ABSTRACT METHODS" .IX Header "ABSTRACT METHODS" .ie n .IP "$proc\->\fBread_handle()\fR" 4 .el .IP "\f(CW$proc\fR\->\fBread_handle()\fR" 4 .IX Item "$proc->read_handle()" Should return a read handle for reading from the child. .ie n .IP "$proc\->\fBwrite_handle()\fR" 4 .el .IP "\f(CW$proc\fR\->\fBwrite_handle()\fR" 4 .IX Item "$proc->write_handle()" Should return a write handle for writing to the child. .ie n .IP "$proc\->init( @shared )" 4 .el .IP "\f(CW$proc\fR\->init( \f(CW@shared\fR )" 4 .IX Item "$proc->init( @shared )" Called by new during construction .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.