GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  NET::SSH::PERL::COMP (3)

.ds Aq ’

NAME

Net::SSH::Perl::Comp - Compression/Decompression base class

CONTENTS

SYNOPSIS



    use Net::SSH::Perl::Comp;
    my $comp = Net::SSH::Perl::Comp->new( $comp_type );
    $comp->compress($data);



DESCRIPTION

Net::SSH::Perl::Comp is a base class for compression/decompression classes. Currently the only such class is the Zlib implementation (using Compress::Zlib), which is the class Net::SSH::Perl::Comp::Zlib.

Each compression object generally has its own internal state; this state changes when you compress or decompress data. The SSH protocol dictates that you must have two separate objects to compress and decompress data: one for compression, one for decompression. So, for example, you would create two Net::SSH::Perl::Comp objects:



    my $in = Net::SSH::Perl::Comp->new(Zlib);
    my $inflated = $in->decompress($data);

    my $out = Net::SSH::Perl::Comp->new(Zlib);
    my $deflated = $out->compress($data);



USAGE

CW$comp = Net::SSH::Perl::Comp->new( CW$comp_type [, CW@args ] )

Constructs a new compression object of compression type $comp_type and returns that object.

If @args are provided, the class’s init method is called with those arguments, for any post-creation initialization.

CW$comp->init($level)

Initializes $comp and sets the compression level to $level. This method will be called automatically from new if you’ve provided @args to new. So, for example, you could write:



    my $comp = Net::SSH::Perl::Comp->new(Zlib, 5);



To create a new Zlib compression object and initialize its compression level to 5.

CW$comp->compress( CW$data )

Compresses $data using the underlying compression mechanism; returns the compressed data.

CW$comp->decompress( CW$data )

Decompresses $data using the underlying decompression mechanism; returns the decompressed data.

CW$comp->enable

Enables the compression object. This is useful in the context of the key exchange (Kex) classes, which create a new compression object during key negotiation, but don’t actually turn it on (enable it) until receiving/sending the SSH2_MSG_NEWKEYS message.

Net::SSH::Perl::Comp objects (and subclasses) are disabled by default.

CW$comp->enabled

Returns the state of the enabled flag, ie. whether the compression object is turned on.

This is used by Net::SSH::Perl::Packet when determining whether data it receives/sends to the server should be decompressed/compressed, respectively.

AUTHOR & COPYRIGHTS

Please see the Net::SSH::Perl manpage for author, copyright, and license information.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 NET::SSH::PERL::COMP (3) 2015-09-12

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.