.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "XML::Filter::Tee 3pm" .TH XML::Filter::Tee 3pm "2020-12-29" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" XML::Filter::Tee \- Send SAX events to multiple processor, with switching .SH "VERSION" .IX Header "VERSION" version 0.46 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 6 \& my $t = XML::Filter::Tee\->new( \& { Handler => $h0 }, \& { Handler => $h1 }, \& { Handler => $h2 }, \& ... \& ); \& \& ## Altering the handlers list: \& $t\->set_handlers( $h0, $h1, $h2, $h3 ); \& \& ## Controlling flow to a handler by number and by reference: \& $t\->disable_handler( 0 ); \& $t\->enable_handler( 0 ); \& \& $t\->disable_handler( $h0 ); \& $t\->enable_handler( $h0 ); \& \& ## Use in a SAX machine (though see L and \& ## L for a more convenient way to build a machine \& ## like this): \& my $m = Machine( \& [ Intake => "XML::Filter::Tee" => qw( A B ) ], \& [ A => ">>log.xml" ], \& [ B => \e*OUTPUT ], \& ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" XML::Filter::Tee is a \s-1SAX\s0 filter that passes each event it receives on to a list of downstream handlers. .PP It's like XML::Filter::SAXT in that the events are not buffered; each event is sent first to the tap, and then to the branch (this is different from XML::SAX::Dispatcher, which buffers the events). Unlike XML::Filter::SAXT, it allows it's list of handlers to be reconfigured (via \*(L"set_handlers\*(R") and it allows control over which handlers are allowed to receive events. These features are designed to make XML::Filter::Tee instances more useful with \s-1SAX\s0 machines, but they to add some overhead relative to XML::Filter::SAXT. .PP The events are not copied, since they may be data structures that are difficult or impossibly to copy properly, like parts of a C\-based \s-1DOM\s0 implementation. This means that the handlers must not alter the events or later handlers will see the alterations. .SH "NAME" XML::Filter::Tee \- Send SAX events to multiple processor, with switching .SH "METHODS" .IX Header "METHODS" .IP "new" 4 .IX Item "new" .Vb 6 \& my $t = XML::Filter::Tee\->new( \& { Handler => $h0 }, \& { Handler => $h1 }, \& { Handler => $h2 }, \& ... \& ); .Ve .IP "set_handlers" 4 .IX Item "set_handlers" .Vb 8 \& $t\->set_handlers( $h0, $h1, $h2 ); \& $t\->set_handlers( { \& Handler => $h0, \& }, \& { \& Handler => $h1, \& }, \& ); .Ve .Sp Replaces the current list of handlers with new ones. .Sp Can also name handlers to make enabling/disabling them by name easier: .Sp .Vb 8 \& $m\->set_handlers( { \& Handler => $validator, \& Name => "Validator", \& }, \& { \& Handler => $outputer, \& }, \& ); \& \& $m\->disable_handler( "Validator" ); .Ve .IP "disable_handler" 4 .IX Item "disable_handler" .Vb 3 \& $t\->disable_handler( 0 ); ## By location \& $t\->disable_handler( "Validator" ); ## By name \& $t\->disable_handler( $h0 ); ## By reference .Ve .Sp Stops sending events to the indicated handler. .IP "enable_handler" 4 .IX Item "enable_handler" .Vb 3 \& $t\->enable_handler( 0 ); ## By location \& $t\->enable_handler( "Validator" ); ## By name \& $t\->enable_handler( $h0 ); ## By reference .Ve .Sp Stops sending events to the indicated handler. .SH "AUTHOR" .IX Header "AUTHOR" .Vb 1 \& Barrie Slaymaker .Ve .SH "COPYRIGHT" .IX Header "COPYRIGHT" .Vb 1 \& Copyright 2002, Barrie Slaymaker, All Rights Reserved .Ve .PP You may use this module under the terms of the Artistic, \s-1GNU\s0 Public, or \&\s-1BSD\s0 licenses, as you choose. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Barry Slaymaker .IP "\(bu" 4 Chris Prather .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 by Barry Slaymaker. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.