Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Multiplexer.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 "TAP::Parser::Multiplexer 3perl"
58 .TH TAP::Parser::Multiplexer 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 TAP::Parser::Multiplexer \- Multiplex multiple TAP::Parsers
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use TAP::Parser::Multiplexer;
72 \&
73 \& my $mux = TAP::Parser::Multiplexer\->new;
74 \& $mux\->add( $parser1, $stash1 );
75 \& $mux\->add( $parser2, $stash2 );
76 \& while ( my ( $parser, $stash, $result ) = $mux\->next ) {
77 \& # do stuff
78 \& }
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\f(CW\*(C`TAP::Parser::Multiplexer\*(C'\fR gathers input from multiple TAP::Parsers.
83 Internally it calls select on the input file handles for those parsers
84 to wait for one or more of them to have input available.
85 .PP
86 See TAP::Harness for an example of its use.
87 .SH METHODS
88 .IX Header "METHODS"
89 .SS "Class Methods"
90 .IX Subsection "Class Methods"
91 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
92 .IX Subsection "new"
93 .PP
94 .Vb 1
95 \& my $mux = TAP::Parser::Multiplexer\->new;
96 .Ve
97 .PP
98 Returns a new \f(CW\*(C`TAP::Parser::Multiplexer\*(C'\fR object.
99 .SS "Instance Methods"
100 .IX Subsection "Instance Methods"
101 \fR\f(CI\*(C`add\*(C'\fR\fI\fR
102 .IX Subsection "add"
103 .PP
104 .Vb 1
105 \& $mux\->add( $parser, $stash );
106 .Ve
107 .PP
108 Add a TAP::Parser to the multiplexer. \f(CW$stash\fR is an optional opaque
109 reference that will be returned from \f(CW\*(C`next\*(C'\fR along with the parser and
110 the next result.
111 .PP
112 \fR\f(CI\*(C`parsers\*(C'\fR\fI\fR
113 .IX Subsection "parsers"
114 .PP
115 .Vb 1
116 \& my $count = $mux\->parsers;
117 .Ve
118 .PP
119 Returns the number of parsers. Parsers are removed from the multiplexer
120 when their input is exhausted.
121 .PP
122 \fR\f(CI\*(C`next\*(C'\fR\fI\fR
123 .IX Subsection "next"
124 .PP
125 Return a result from the next available parser. Returns a list
126 containing the parser from which the result came, the stash that
127 corresponds with that parser and the result.
128 .PP
129 .Vb 1
130 \& my ( $parser, $stash, $result ) = $mux\->next;
131 .Ve
132 .PP
133 If \f(CW$result\fR is undefined the corresponding parser has reached the end
134 of its input (and will automatically be removed from the multiplexer).
135 .PP
136 When all parsers are exhausted an empty list will be returned.
137 .PP
138 .Vb 11
139 \& if ( my ( $parser, $stash, $result ) = $mux\->next ) {
140 \& if ( ! defined $result ) {
141 \& # End of this parser
142 \& }
143 \& else {
144 \& # Process result
145 \& }
146 \& }
147 \& else {
148 \& # All parsers finished
149 \& }
150 .Ve
151 .SH "See Also"
152 .IX Header "See Also"
153 TAP::Parser
154 .PP
155 TAP::Harness