autobahn.websocket.compress_snappy

Classes

PerMessageSnappy

permessage-snappy WebSocket extension processor.

PerMessageSnappyMixin

Mixin class for this extension.

PerMessageSnappyOffer

Set of extension parameters for permessage-snappy WebSocket extension

PerMessageSnappyOfferAccept

Set of parameters with which to accept an permessage-snappy offer

PerMessageSnappyResponse

Set of parameters for permessage-snappy responded by server.

PerMessageSnappyResponseAccept

Set of parameters with which to accept an permessage-snappy response

Module Contents

class PerMessageSnappy(is_server, server_no_context_takeover, client_no_context_takeover)[source]

Bases: autobahn.websocket.compress_base.PerMessageCompress, PerMessageSnappyMixin

permessage-snappy WebSocket extension processor.

__json__()[source]
__repr__()[source]
_compressor = None[source]
_decompressor = None[source]
_is_server[source]
client_no_context_takeover[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_no_context_takeover[source]
start_compress_message()[source]
start_decompress_message()[source]
class PerMessageSnappyMixin[source]

Bases: object

Mixin class for this extension.

EXTENSION_NAME = 'permessage-snappy'[source]

Name of this WebSocket extension.

class PerMessageSnappyOffer(accept_no_context_takeover=True, request_no_context_takeover=False)[source]

Bases: autobahn.websocket.compress_base.PerMessageCompressOffer, PerMessageSnappyMixin

Set of extension parameters for permessage-snappy 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_no_context_takeover = 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-snappy provided by a client to a server.

Parameters:

params (list) – Output from autobahn.websocket.WebSocketProtocol._parseExtensionsHeader().

Returns:

A new instance of autobahn.compress.PerMessageSnappyOffer.

Return type:

obj

request_no_context_takeover = False[source]
class PerMessageSnappyOfferAccept(offer, request_no_context_takeover=False, no_context_takeover=None)[source]

Bases: autobahn.websocket.compress_base.PerMessageCompressOfferAccept, PerMessageSnappyMixin

Set of parameters with which to accept an permessage-snappy 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

get_extension_string()[source]

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

Returns:

PMCE configuration string.

Return type:

str

no_context_takeover = None[source]
offer[source]
request_no_context_takeover = False[source]
class PerMessageSnappyResponse(client_no_context_takeover, server_no_context_takeover)[source]

Bases: autobahn.websocket.compress_base.PerMessageCompressResponse, PerMessageSnappyMixin

Set of parameters for permessage-snappy 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_no_context_takeover[source]
classmethod parse(params)[source]

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

Parameters:

params (list) – Output from autobahn.websocket.WebSocketProtocol._parseExtensionsHeader().

Returns:

A new instance of autobahn.compress.PerMessageSnappyResponse.

Return type:

obj

server_no_context_takeover[source]
class PerMessageSnappyResponseAccept(response, no_context_takeover=None)[source]

Bases: autobahn.websocket.compress_base.PerMessageCompressResponseAccept, PerMessageSnappyMixin

Set of parameters with which to accept an permessage-snappy 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

no_context_takeover = None[source]
response[source]