.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "POE::Filter::RecordBlock 3"
.TH POE::Filter::RecordBlock 3 2024-07-13 "perl v5.38.2" "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
POE::Filter::RecordBlock \- translate between discrete records and blocks of them
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Hello, dear reader.  This SYNOPSIS does not contain a fully
functioning sample program because your humble documenter cannot come
up with a short, reasonable use case for this module.  Please contact
the maintainer if this module is useful to you.  Otherwise you may wake
up one morning to discover that it has been deprecated.
.PP
.Vb 6
\&  $filter = new POE::Filter::RecordBlock( BlockSize => 4 );
\&  $arrayref_of_arrayrefs = $filter\->get($arrayref_of_raw_data);
\&  $arrayref_of_raw_chunks = $filter\->put($arrayref_of_arrayrefs);
\&  $arrayref_of_raw_chunks = $filter\->put($single_arrayref);
\&  $arrayref_of_leftovers = $filter\->get_pending;
\&  $arrayref_of_leftovers = $filter\->put_pending;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
On input, POE::Filter::RecordBlock translates a stream of discrete
items into a "block" of them.  It does this by collecting items until
it has BlockSize of them, then returning the lot of them in an array
reference.
.PP
On output, this module flattens array references.
.PP
This module may be deprecated in the future.  Please contact the
maintainer if this module is useful to you.
.SH "PUBLIC FILTER METHODS"
.IX Header "PUBLIC FILTER METHODS"
In addition to the usual POE::Filter methods, POE::Filter::RecordBlock
supports the following.
.SS new
.IX Subsection "new"
\&\fBnew()\fR takes at least one mandatory argument, BlockSize, which must be
defined and greater than zero.  \fBnew()\fR also accepts a CheckPut Boolean
parameter that indicates whether \fBput()\fR should check for the proper
BlockSize before allowing data to be serialized.
.PP
Using CheckPut is not recommended, as it enables a write buffer in the
filter, therefore breaking \fBput()\fR for normal use.
.SS put_pending
.IX Subsection "put_pending"
\&\fBput_pending()\fR returns an arrayref of any records that are waiting to
be sent.  It is the outbound equivalent of POE::Filter's \fBget_pending()\fR
accessor.  \fBput_pending()\fR is not part of the canonical POE::Filter API,
so nothing will use it.  It's up to applications to handle pending
output, whenever it's appropriate to do so.
.SS blocksize
.IX Subsection "blocksize"
\&\fBblocksize()\fR is an accessor/mutator for POE::Filter::RecordBlock's
BlockSize value.
.SS checkput
.IX Subsection "checkput"
\&\fBcheckput()\fR is an accessor/mutator for POE::Filter::RecordBlock's
CheckPut flag.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE::Filter for more information about filters in general.
.PP
POE::Filter::Stackable for more details on stacking filters.
.SH BUGS
.IX Header "BUGS"
This filter may maintain an output buffer that no other part of POE
will know about.
.PP
This filter implements a highly specialized and seemingly not
generally useful feature.
.PP
Does anyone use this filter?  This filter may be deprecated if nobody
speaks up.
.SH "AUTHORS & COPYRIGHTS"
.IX Header "AUTHORS & COPYRIGHTS"
The RecordBlock filter was contributed by Dieter Pearcey.
Documentation is provided by Rocco Caputo.
.PP
Please see the POE manpage for more information about authors and
contributors.