The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Net::WebSocket::PMCE::deflate::Client - permessage-deflate for a client

SYNOPSIS

my $deflate = Net::WebSocket::PMCE::deflate::Server->new( %opts );

#Send this to the server.
my $handshake = $deflate->create_handshake_object();

#You’ll probably want Net::WebSocket::Handshake
#to do this for you, but just in case:
#$deflate->consume_parameters( @params_kv );

#OPTIONAL: Inspect $deflate to be sure you’re happy with the setup
#that the client’s parameters allow.

#...and now use this to send/receive messages.
my $data_obj = $deflate->create_data_object();

DESCRIPTION

See Net::WebSocket::PMCE::deflate for general information about this class.

METHODS

OBJ->consume_parameters( KEY1 => VALUE1, .. )

Inherited from the base class. The alterations made in response to the different parameters are:

  • <client_no_context_takeover> - Sets the object’s deflate_no_context_takeover flag.

  • <server_no_context_takeover> - If the object’s inflate_no_context_takeover flag is set, and if we do *not* receive this flag from the peer, then we die(). This option is ignored otherwise.

  • <client_max_window_bits> - If given and less than the object’s deflate_max_window_bits option, then that option is reduced to the new value.

  • <server_max_window_bits> - If given and less than the object’s inflate_max_window_bits option, then that option is reduced to the new value. If given and greater than the object’s inflate_max_window_bits option, then we die().