autobahn.websocket.compress_bzip2¶

Classes¶

`PerMessageBzip2`	permessage-bzip2 WebSocket extension processor.
`PerMessageBzip2Mixin`	Mixin class for this extension.
`PerMessageBzip2Offer`	Set of extension parameters for permessage-bzip2 WebSocket extension
`PerMessageBzip2OfferAccept`	Set of parameters with which to accept an permessage-bzip2 offer
`PerMessageBzip2Response`	Set of parameters for permessage-bzip2 responded by server.
`PerMessageBzip2ResponseAccept`	Set of parameters with which to accept an permessage-bzip2 response

Module Contents¶

class PerMessageBzip2(is_server, server_max_compress_level, client_max_compress_level)[source]¶

Bases: autobahn.websocket.compress_base.PerMessageCompress, PerMessageBzip2Mixin

permessage-bzip2 WebSocket extension processor.

DEFAULT_COMPRESS_LEVEL = 9[source]¶

__json__()[source]¶

__repr__()[source]¶

_compressor = None[source]¶

_decompressor = None[source]¶

_isServer[source]¶

client_max_compress_level[source]¶

compress_message_data(data)[source]¶

classmethod create_from_offer_accept(is_server, accept)[source]¶

classmethod create_from_response_accept(is_server, accept)[source]¶

decompress_message_data(data)[source]¶

end_compress_message()[source]¶

end_decompress_message()[source]¶

server_max_compress_level[source]¶

start_compress_message()[source]¶

start_decompress_message()[source]¶

class PerMessageBzip2Mixin[source]¶

Bases: object

Mixin class for this extension.

COMPRESS_LEVEL_PERMISSIBLE_VALUES = [1, 2, 3, 4, 5, 6, 7, 8, 9][source]¶: Permissible value for compression level parameter.

EXTENSION_NAME = 'permessage-bzip2'[source]¶: Name of this WebSocket extension.

class PerMessageBzip2Offer(accept_max_compress_level=True, request_max_compress_level=0)[source]¶

Bases: autobahn.websocket.compress_base.PerMessageCompressOffer, PerMessageBzip2Mixin

Set of extension parameters for permessage-bzip2 WebSocket extension offered by a client to a server.

__json__()[source]¶

Returns a JSON serializable object representation.

Returns:: JSON serializable representation.
Return type:: dict

__repr__()[source]¶

Returns Python object representation that can be eval’ed to reconstruct the object.

Returns:: Python string representation.
Return type:: str

accept_max_compress_level = True[source]¶

get_extension_string()[source]¶

Returns the WebSocket extension configuration string as sent to the server.

Returns:: PMCE configuration string.
Return type:: str

classmethod parse(params)[source]¶

Parses a WebSocket extension offer for permessage-bzip2 provided by a client to a server.

Parameters:: params (list) – Output from autobahn.websocket.WebSocketProtocol._parseExtensionsHeader().
Returns:: object – A new instance of autobahn.compress.PerMessageBzip2Offer.

request_max_compress_level = 0[source]¶

class PerMessageBzip2OfferAccept(offer, request_max_compress_level=0, compress_level=None)[source]¶

Bases: autobahn.websocket.compress_base.PerMessageCompressOfferAccept, PerMessageBzip2Mixin

Set of parameters with which to accept an permessage-bzip2 offer from a client by a server.

__json__()[source]¶

Returns a JSON serializable object representation.

Returns:: JSON serializable representation.
Return type:: dict

__repr__()[source]¶

Returns Python object representation that can be eval’ed to reconstruct the object.

Returns:: Python string representation.
Return type:: str

compress_level = None[source]¶

get_extension_string()[source]¶

Returns the WebSocket extension configuration string as sent to the server.

Returns:: PMCE configuration string.
Return type:: str

offer[source]¶

request_max_compress_level = 0[source]¶

class PerMessageBzip2Response(client_max_compress_level, server_max_compress_level)[source]¶

Bases: autobahn.websocket.compress_base.PerMessageCompressResponse, PerMessageBzip2Mixin

Set of parameters for permessage-bzip2 responded by server.

__json__()[source]¶

Returns a JSON serializable object representation.

Returns:: JSON serializable representation.
Return type:: dict

__repr__()[source]¶

Returns Python object representation that can be eval’ed to reconstruct the object.

Returns:: Python string representation.
Return type:: str

client_max_compress_level[source]¶

classmethod parse(params)[source]¶

Parses a WebSocket extension response for permessage-bzip2 provided by a server to a client.

Parameters:: params (list) – Output from autobahn.websocket.WebSocketProtocol._parseExtensionsHeader().
Returns:: A new instance of autobahn.compress.PerMessageBzip2Response.
Return type:: obj

server_max_compress_level[source]¶

class PerMessageBzip2ResponseAccept(response, compress_level=None)[source]¶

Bases: autobahn.websocket.compress_base.PerMessageCompressResponseAccept, PerMessageBzip2Mixin

Set of parameters with which to accept an permessage-bzip2 response from a server by a client.

__json__()[source]¶

Returns a JSON serializable object representation.

Returns:: JSON serializable representation.
Return type:: dict

__repr__()[source]¶

Returns Python object representation that can be eval’ed to reconstruct the object.

Returns:: Python string representation.
Return type:: str

compress_level = None[source]¶

response[source]¶