Debian Codegraph @

upstream/debian-unstable/man3/IO::Pipe.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "IO::Pipe 3perl"
58 .TH IO::Pipe 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 IO::Pipe \- supply object methods for pipes
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use IO::Pipe;
69 \&
70 \& $pipe = IO::Pipe\->new();
71 \&
72 \& if($pid = fork()) { # Parent
73 \& $pipe\->reader();
74 \&
75 \& while(<$pipe>) {
76 \& ...
77 \& }
78 \&
79 \& }
80 \& elsif(defined $pid) { # Child
81 \& $pipe\->writer();
82 \&
83 \& print $pipe ...
84 \& }
85 \&
86 \& or
87 \&
88 \& $pipe = IO::Pipe\->new();
89 \&
90 \& $pipe\->reader(qw(ls \-l));
91 \&
92 \& while(<$pipe>) {
93 \& ...
94 \& }
95 .Ve
96 .SH DESCRIPTION
97 .IX Header "DESCRIPTION"
98 \&\f(CW\*(C`IO::Pipe\*(C'\fR provides an interface to creating pipes between
99 processes.
100 .SH CONSTRUCTOR
101 .IX Header "CONSTRUCTOR"
102 .IP "new ( [READER, WRITER] )" 4
103 .IX Item "new ( [READER, WRITER] )"
104 Creates an \f(CW\*(C`IO::Pipe\*(C'\fR, which is a reference to a newly created symbol
105 (see the Symbol package). \f(CW\*(C`IO::Pipe::new\*(C'\fR optionally takes two
106 arguments, which should be objects blessed into \f(CW\*(C`IO::Handle\*(C'\fR, or a
107 subclass thereof. These two objects will be used for the system call
108 to \f(CW\*(C`pipe\*(C'\fR. If no arguments are given then method \f(CW\*(C`handles\*(C'\fR is called
109 on the new \f(CW\*(C`IO::Pipe\*(C'\fR object.
110 .Sp
111 These two handles are held in the array part of the GLOB until either
112 \&\f(CW\*(C`reader\*(C'\fR or \f(CW\*(C`writer\*(C'\fR is called.
113 .SH METHODS
114 .IX Header "METHODS"
115 .IP "reader ([ARGS])" 4
116 .IX Item "reader ([ARGS])"
117 The object is re-blessed into a sub-class of \f(CW\*(C`IO::Handle\*(C'\fR, and becomes a
118 handle at the reading end of the pipe. If \f(CW\*(C`ARGS\*(C'\fR are given then \f(CW\*(C`fork\*(C'\fR
119 is called and \f(CW\*(C`ARGS\*(C'\fR are passed to exec.
120 .IP "writer ([ARGS])" 4
121 .IX Item "writer ([ARGS])"
122 The object is re-blessed into a sub-class of \f(CW\*(C`IO::Handle\*(C'\fR, and becomes a
123 handle at the writing end of the pipe. If \f(CW\*(C`ARGS\*(C'\fR are given then \f(CW\*(C`fork\*(C'\fR
124 is called and \f(CW\*(C`ARGS\*(C'\fR are passed to exec.
125 .IP "handles ()" 4
126 .IX Item "handles ()"
127 This method is called during construction by \f(CW\*(C`IO::Pipe::new\*(C'\fR
128 on the newly created \f(CW\*(C`IO::Pipe\*(C'\fR object. It returns an array of two objects
129 blessed into \f(CW\*(C`IO::Pipe::End\*(C'\fR, or a subclass thereof.
130 .SH "SEE ALSO"
131 .IX Header "SEE ALSO"
132 IO::Handle
133 .SH AUTHOR
134 .IX Header "AUTHOR"
135 Graham Barr. Currently maintained by the Perl Porters. Please report all
136 bugs at <https://github.com/Perl/perl5/issues>.
137 .SH COPYRIGHT
138 .IX Header "COPYRIGHT"
139 Copyright (c) 1996\-8 Graham Barr <[email protected]>. All rights reserved.
140 This program is free software; you can redistribute it and/or
141 modify it under the same terms as Perl itself.