local-lib5/man/man3/TAP::Parser::Multiplexer.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "TAP::Parser::Multiplexer 3"
 132 .TH TAP::Parser::Multiplexer 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 TAP::Parser::Multiplexer \- Multiplex multiple TAP::Parsers
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 Version 3.17
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 .Vb 1
 141 \&    use TAP::Parser::Multiplexer;
 142 .Ve
 143 .PP
 144 .Vb 6
 145 \&    my $mux = TAP::Parser::Multiplexer\->new;
 146 \&    $mux\->add( $parser1, $stash1 );
 147 \&    $mux\->add( $parser2, $stash2 );
 148 \&    while ( my ( $parser, $stash, $result ) = $mux\->next ) {
 149 \&        # do stuff
 150 \&    }
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\f(CW\*(C`TAP::Parser::Multiplexer\*(C'\fR gathers input from multiple TAP::Parsers.
 155 Internally it calls select on the input file handles for those parsers
 156 to wait for one or more of them to have input available.
 157 .PP
 158 See TAP::Harness for an example of its use.
 159 .SH "METHODS"
 160 .IX Header "METHODS"
 161 .Sh "Class Methods"
 162 .IX Subsection "Class Methods"
 163 \fI\f(CI\*(C`new\*(C'\fI\fR
 164 .IX Subsection "new"
 165 .PP
 166 .Vb 1
 167 \&    my $mux = TAP::Parser::Multiplexer\->new;
 168 .Ve
 169 .PP
 170 Returns a new \f(CW\*(C`TAP::Parser::Multiplexer\*(C'\fR object.
 171 .Sh "Instance Methods"
 172 .IX Subsection "Instance Methods"
 173 \fI\f(CI\*(C`add\*(C'\fI\fR
 174 .IX Subsection "add"
 175 .PP
 176 .Vb 1
 177 \&  $mux\->add( $parser, $stash );
 178 .Ve
 179 .PP
 180 Add a TAP::Parser to the multiplexer. \f(CW$stash\fR is an optional opaque
 181 reference that will be returned from \f(CW\*(C`next\*(C'\fR along with the parser and
 182 the next result.
 183 .PP
 184 \fI\f(CI\*(C`parsers\*(C'\fI\fR
 185 .IX Subsection "parsers"
 186 .PP
 187 .Vb 1
 188 \&  my $count   = $mux\->parsers;
 189 .Ve
 190 .PP
 191 Returns the number of parsers. Parsers are removed from the multiplexer
 192 when their input is exhausted.
 193 .PP
 194 \fI\f(CI\*(C`next\*(C'\fI\fR
 195 .IX Subsection "next"
 196 .PP
 197 Return a result from the next available parser. Returns a list
 198 containing the parser from which the result came, the stash that
 199 corresponds with that parser and the result.
 200 .PP
 201 .Vb 1
 202 \&    my ( $parser, $stash, $result ) = $mux\->next;
 203 .Ve
 204 .PP
 205 If \f(CW$result\fR is undefined the corresponding parser has reached the end
 206 of its input (and will automatically be removed from the multiplexer).
 207 .PP
 208 When all parsers are exhausted an empty list will be returned.
 209 .PP
 210 .Vb 11
 211 \&    if ( my ( $parser, $stash, $result ) = $mux\->next ) {
 212 \&        if ( ! defined $result ) {
 213 \&            # End of this parser
 214 \&        }
 215 \&        else {
 216 \&            # Process result
 217 \&        }
 218 \&    }
 219 \&    else {
 220 \&        # All parsers finished
 221 \&    }
 222 .Ve
 223 .SH "See Also"
 224 .IX Header "See Also"
 225 TAP::Parser
 226 .PP
 227 TAP::Harness