autobahn.wamp.serializer

Classes

JsonObjectSerializer
JsonSerializer	Base class for WAMP serializers. A WAMP serializer is the core glue between
Serializer	Base class for WAMP serializers. A WAMP serializer is the core glue between

Module Contents

class JsonObjectSerializer(batched=False, use_binary_hex_encoding=False, use_decimal_from_str=False, use_decimal_from_float=False)

Bases: object

BINARY = False

JSON_MODULE

The JSON module used (now only stdlib).

NAME = 'json'

_batched = False

_use_binary_hex_encoding = False

_use_decimal_from_float = False

_use_decimal_from_str = False

serialize(obj)

Implements autobahn.wamp.interfaces.IObjectSerializer.serialize()

unserialize(payload)

Implements autobahn.wamp.interfaces.IObjectSerializer.unserialize()

class JsonSerializer(batched=False, use_binary_hex_encoding=False, use_decimal_from_str=False)

Bases: Serializer

Base class for WAMP serializers. A WAMP serializer is the core glue between parsed WAMP message objects and the bytes on wire (the transport).

MIME_TYPE = 'application/json'

MIME type announced in HTTP request/response headers when running WAMP-over-Longpoll HTTP fallback.

PAYLOAD_SERIALIZER_ID = 'json'

Serializer for application payload. For JSON transport, both envelope and payload use JSON serialization.

RAWSOCKET_SERIALIZER_ID = 1

ID used in lower four bits of second octet in RawSocket opening handshake identify the serializer with WAMP-over-RawSocket.

SERIALIZER_ID = 'json'

ID used as part of the WebSocket subprotocol name to identify the serializer with WAMP-over-WebSocket.

class Serializer(serializer)

Bases: object

Base class for WAMP serializers. A WAMP serializer is the core glue between parsed WAMP message objects and the bytes on wire (the transport).

MESSAGE_TYPE_MAP

Mapping of WAMP message type codes to WAMP message classes.

RATED_MESSAGE_SIZE = 512

Serialized WAMP message payload size per rated WAMP message.

_autoreset_callback = None

_autoreset_duration = None

_autoreset_rated_messages = None

_serialized_bytes = 0

_serialized_messages = 0

_serialized_rated_messages = 0

_serializer

_stats_cycle = 0

_stats_reset

_unserialized_bytes = 0

_unserialized_messages = 0

_unserialized_rated_messages = 0

serialize(msg: autobahn.wamp.interfaces.IMessage) → Tuple[bytes, bool]

Implements autobahn.wamp.interfaces.ISerializer.serialize()

serialize_payload(data)

Serialize application payload data (args/kwargs/payload).

Uses the payload serializer configured for this transport serializer. For traditional serializers (JSON, CBOR, MsgPack, UBJSON), this is the same as the envelope serializer. For FlatBuffers, this can be different.

Parameters:

data – The data to serialize (list for args, dict for kwargs).

Returns:

Serialized bytes.

Return type:

bytes

set_stats_autoreset(rated_messages, duration, callback, reset_now=False)

Configure a user callback invoked when accumulated stats hit specified threshold. When the specified number of rated messages have been processed or the specified duration has passed, statistics are automatically reset, and the last statistics is provided to the user callback.

Parameters:

• rated_messages (int) – Number of rated messages that should trigger an auto-reset.

• duration (int) – Duration in ns that when passed will trigger an auto-reset.

• callback (callable) – User callback to be invoked when statistics are auto-reset. The function will be invoked with a single positional argument: the accumulated statistics before the reset.

stats(reset=True, details=False)

Get (and reset) serializer statistics.

Parameters:

• reset (bool) – If True, reset the serializer statistics.

• details (bool) – If True, return detailed statistics split up by serialization/unserialization.

Returns:

Serializer statistics, eg:

{
    "timestamp": 1574156576688704693,
    "duration": 34000000000,
    "bytes": 0,
    "messages": 0,
    "rated_messages": 0
}

Return type:

dict

stats_bytes()

Get serializer statistics: bytes (serialized + unserialized).

Returns:

Number of bytes.

Return type:

int

stats_messages()

Get serializer statistics: messages (serialized + unserialized).

Returns:

Number of messages.

Return type:

int

stats_rated_messages()

Get serializer statistics: rated messages (serialized + unserialized).

Returns:

Number of rated messages.

Return type:

int

stats_reset()

Get serializer statistics: timestamp when statistics were last reset.

Returns:

Last reset time of statistics (UTC, ns since Unix epoch)

Return type:

int

unserialize(payload: bytes, isBinary: bool | None = None) → List[autobahn.wamp.interfaces.IMessage]

Implements autobahn.wamp.interfaces.ISerializer.unserialize()