Debian Codegraph @

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