autobahn.wamp.serializer

---

Module Contents

Classes

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

class autobahn.wamp.serializer.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).

RATED_MESSAGE_SIZE = 512

Serialized WAMP message payload size per rated WAMP message.

MESSAGE_TYPE_MAP

Mapping of WAMP message type codes to WAMP message classes.

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

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

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

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

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

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

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

class autobahn.wamp.serializer.JsonObjectSerializer(batched=False, use_binary_hex_encoding=False, use_decimal_from_str=False, use_decimal_from_float=False)

Bases: object

JSON_MODULE

The JSON module used (now only stdlib).

NAME = json

BINARY = False

serialize(obj)

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

unserialize(payload)

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

class autobahn.wamp.serializer.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).

SERIALIZER_ID = json

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

RAWSOCKET_SERIALIZER_ID = 1

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

MIME_TYPE = application/json

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