Debian Codegraph @

upstream/mageia-cauldron/man3pm/IO::Pipe.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "IO::Pipe 3pm"
61 .TH IO::Pipe 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 IO::Pipe \- supply object methods for pipes
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use IO::Pipe;
72 \&
73 \& $pipe = IO::Pipe\->new();
74 \&
75 \& if($pid = fork()) { # Parent
76 \& $pipe\->reader();
77 \&
78 \& while(<$pipe>) {
79 \& ...
80 \& }
81 \&
82 \& }
83 \& elsif(defined $pid) { # Child
84 \& $pipe\->writer();
85 \&
86 \& print $pipe ...
87 \& }
88 \&
89 \& or
90 \&
91 \& $pipe = IO::Pipe\->new();
92 \&
93 \& $pipe\->reader(qw(ls \-l));
94 \&
95 \& while(<$pipe>) {
96 \& ...
97 \& }
98 .Ve
99 .SH DESCRIPTION
100 .IX Header "DESCRIPTION"
101 \&\f(CW\*(C`IO::Pipe\*(C'\fR provides an interface to creating pipes between
102 processes.
103 .SH CONSTRUCTOR
104 .IX Header "CONSTRUCTOR"
105 .IP "new ( [READER, WRITER] )" 4
106 .IX Item "new ( [READER, WRITER] )"
107 Creates an \f(CW\*(C`IO::Pipe\*(C'\fR, which is a reference to a newly created symbol
108 (see the Symbol package). \f(CW\*(C`IO::Pipe::new\*(C'\fR optionally takes two
109 arguments, which should be objects blessed into \f(CW\*(C`IO::Handle\*(C'\fR, or a
110 subclass thereof. These two objects will be used for the system call
111 to \f(CW\*(C`pipe\*(C'\fR. If no arguments are given then method \f(CW\*(C`handles\*(C'\fR is called
112 on the new \f(CW\*(C`IO::Pipe\*(C'\fR object.
113 .Sp
114 These two handles are held in the array part of the GLOB until either
115 \&\f(CW\*(C`reader\*(C'\fR or \f(CW\*(C`writer\*(C'\fR is called.
116 .SH METHODS
117 .IX Header "METHODS"
118 .IP "reader ([ARGS])" 4
119 .IX Item "reader ([ARGS])"
120 The object is re\-blessed into a sub\-class of \f(CW\*(C`IO::Handle\*(C'\fR, and becomes a
121 handle at the reading end of the pipe. If \f(CW\*(C`ARGS\*(C'\fR are given then \f(CW\*(C`fork\*(C'\fR
122 is called and \f(CW\*(C`ARGS\*(C'\fR are passed to exec.
123 .IP "writer ([ARGS])" 4
124 .IX Item "writer ([ARGS])"
125 The object is re\-blessed into a sub\-class of \f(CW\*(C`IO::Handle\*(C'\fR, and becomes a
126 handle at the writing end of the pipe. If \f(CW\*(C`ARGS\*(C'\fR are given then \f(CW\*(C`fork\*(C'\fR
127 is called and \f(CW\*(C`ARGS\*(C'\fR are passed to exec.
128 .IP "handles ()" 4
129 .IX Item "handles ()"
130 This method is called during construction by \f(CW\*(C`IO::Pipe::new\*(C'\fR
131 on the newly created \f(CW\*(C`IO::Pipe\*(C'\fR object. It returns an array of two objects
132 blessed into \f(CW\*(C`IO::Pipe::End\*(C'\fR, or a subclass thereof.
133 .SH "SEE ALSO"
134 .IX Header "SEE ALSO"
135 IO::Handle
136 .SH AUTHOR
137 .IX Header "AUTHOR"
138 Graham Barr. Currently maintained by the Perl Porters. Please report all
139 bugs at <https://github.com/Perl/perl5/issues>.
140 .SH COPYRIGHT
141 .IX Header "COPYRIGHT"
142 Copyright (c) 1996\-8 Graham Barr <[email protected]>. All rights reserved.
143 This program is free software; you can redistribute it and/or
144 modify it under the same terms as Perl itself.