1POE::Filter::Zlib(3)  User Contributed Perl Documentation POE::Filter::Zlib(3)
2
3
4

NAME

6       POE::Filter::Zlib - A POE filter wrapped around Compress::Zlib
7

VERSION

9       version 2.04
10

SYNOPSIS

12           use POE::Filter::Zlib;
13
14           my $filter = POE::Filter::Zlib->new();
15           my $scalar = 'Blah Blah Blah';
16           my $compressed_array   = $filter->put( [ $scalar ] );
17           my $uncompressed_array = $filter->get( $compressed_array );
18
19           use POE qw(Filter::Stackable Filter::Line Filter::Zlib);
20
21           my ($filter) = POE::Filter::Stackable->new();
22           $filter->push( POE::Filter::Zlib->new(),
23                          POE::Filter::Line->new( InputRegexp => '\015?\012', OutputLiteral => "\015\012" ),
24

DESCRIPTION

26       POE::Filter::Zlib provides a POE filter for performing
27       compression/uncompression using Compress::Zlib. It is suitable for use
28       with POE::Filter::Stackable.
29
30       This filter is not ideal for streaming compressed data over sockets
31       etc. as it employs compress and uncompress zlib functions.
32
33       POE::Filter::Zlib::Stream is recommended for that type of activity.
34

CONSTRUCTOR

36       "new"
37           Creates a new POE::Filter::Zlib object. Takes one optional
38           argument,
39
40             'level': the level of compression to employ.
41
42           Consult Compress::Zlib for details.
43

METHODS

45       "get"
46       "get_one_start"
47       "get_one"
48           Takes an arrayref which is contains lines of compressed input.
49           Returns an arrayref of uncompressed lines.
50
51       "get_pending"
52           Returns any data in a filter's input buffer. The filter's input
53           buffer is not cleared, however.
54
55       "put"
56           Takes an arrayref containing lines of uncompressed output, returns
57           an arrayref of compressed lines.
58
59       "clone"
60           Makes a copy of the filter, and clears the copy's buffer.
61
62       "level"
63           Sets the level of compression employed to the given value. If no
64           value is supplied, returns the current level setting.
65

SEE ALSO

67       POE
68
69       POE::Filter
70
71       POE::Filter::Zlib::Stream
72
73       Compress::Zlib
74
75       POE::Filter::Stackable
76

AUTHORS

78       ·   Chris Williams <chris@bingosnet.co.uk>
79
80       ·   Martijn van Beers
81
83       This software is copyright (c) 2017 by Chris Williams and Martijn van
84       Beers.
85
86       This is free software; you can redistribute it and/or modify it under
87       the same terms as the Perl 5 programming language system itself.
88
89
90
91perl v5.32.0                      2020-07-28              POE::Filter::Zlib(3)
Impressum