man pages section 3: Library Interfaces and Headers

TAP::Parser::Multiplexer (3)

Name

TAP::Parser::Multiplexer - Multiplex multiple TAP::Parsers

Synopsis

use TAP::Parser::Multiplexer;

my $mux = TAP::Parser::Multiplexer->new;
$mux->add( $parser1, $stash1 );
$mux->add( $parser2, $stash2 );
while ( my ( $parser, $stash, $result ) = $mux->next ) {
# do stuff
}

Description

Perl Programmers Reference Guide
                                                   TAP::Parser::Multiplexer(3)



NAME
       TAP::Parser::Multiplexer - Multiplex multiple TAP::Parsers

VERSION
       Version 3.42

SYNOPSIS
           use TAP::Parser::Multiplexer;

           my $mux = TAP::Parser::Multiplexer->new;
           $mux->add( $parser1, $stash1 );
           $mux->add( $parser2, $stash2 );
           while ( my ( $parser, $stash, $result ) = $mux->next ) {
               # do stuff
           }

DESCRIPTION
       "TAP::Parser::Multiplexer" gathers input from multiple TAP::Parsers.
       Internally it calls select on the input file handles for those parsers
       to wait for one or more of them to have input available.

       See TAP::Harness for an example of its use.

METHODS
   Class Methods
       "new"

           my $mux = TAP::Parser::Multiplexer->new;

       Returns a new "TAP::Parser::Multiplexer" object.

   Instance Methods
       "add"

         $mux->add( $parser, $stash );

       Add a TAP::Parser to the multiplexer. $stash is an optional opaque
       reference that will be returned from "next" along with the parser and
       the next result.

       "parsers"

         my $count   = $mux->parsers;

       Returns the number of parsers. Parsers are removed from the multiplexer
       when their input is exhausted.

       "next"

       Return a result from the next available parser. Returns a list
       containing the parser from which the result came, the stash that
       corresponds with that parser and the result.

           my ( $parser, $stash, $result ) = $mux->next;

       If $result is undefined the corresponding parser has reached the end of
       its input (and will automatically be removed from the multiplexer).

       When all parsers are exhausted an empty list will be returned.

           if ( my ( $parser, $stash, $result ) = $mux->next ) {
               if ( ! defined $result ) {
                   # End of this parser
               }
               else {
                   # Process result
               }
           }
           else {
               # All parsers finished
           }

See Also
       TAP::Parser

       TAP::Harness



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14
                                                   TAP::Parser::Multiplexer(3)