cfxdb.realmstore._publication

Classes

Publication	Persisted publication database object.
Publications	Persisted publications archive.
_Publication	Expand methods on the class code generated by flatc.

Module Contents

class Publication(from_fbs=None)

Bases: object

Persisted publication database object.

ENC_ALGO_CRYPTOBOX = 1

ENC_ALGO_MQTT = 2

ENC_ALGO_NONE = 0

ENC_ALGO_XBR = 3

ENC_SER_CBOR = 3

ENC_SER_FLATBUFFERS = 6

ENC_SER_JSON = 1

ENC_SER_MSGPACK = 2

ENC_SER_NONE = 0

ENC_SER_OPAQUE = 5

ENC_SER_UBJSON = 4

__slots__ = ('_from_fbs', '_timestamp', '_publication', '_publisher', '_topic', '_args', '_kwargs',...

__str__()

_acknowledge = None

_args = None

_eligible = None

_eligible_authid = None

_eligible_authrole = None

_enc_algo = None

_enc_key = None

_enc_serializer = None

_exclude = None

_exclude_authid = None

_exclude_authrole = None

_exclude_me = None

_from_fbs = None

_kwargs = None

_payload = None

_publication = None

_publisher = None

_retain = None

_timestamp = None

_topic = None

property acknowledge

If True, the broker was asked to acknowledge the publication with a success or error response.

Returns:

acknowledge flag

Return type:

None or bool

property args

Positional values for application-defined event payload.

Returns:

positional arguments (app payload) of the event (if any)

Return type:

None or list

build(builder)

static cast(buf)

property eligible

List of WAMP session IDs eligible to receive this event.

Returns:

list of eligible session IDs

Return type:

list[int]

property eligible_authid

List of WAMP authids eligible to receive this event.

Returns:

list of eligible authids

Return type:

list[str]

property eligible_authrole

List of WAMP authroles eligible to receive this event.

Returns:

list of eligible authroles

Return type:

list[str]

property enc_algo

When using payload transparency, the encoding algorithm that was used to encode the payload.

Returns:

payload encryption algorithm

Return type:

int

property enc_key

When using payload transparency with an encryption algorithm, the payload encryption key.

Returns:

payload key

Return type:

None or bytes

property enc_serializer

When using payload transparency, the payload object serializer that was used encoding the payload.

Returns:

payload serializer

Return type:

int

property exclude

List of WAMP session IDs to exclude from receiving this event.

Returns:

list of excluded session IDs

Return type:

list[int]

property exclude_authid

List of WAMP authids to exclude from receiving this event.

Returns:

list of excluded authids

Return type:

list[str]

property exclude_authrole

List of WAMP authroles to exclude from receiving this event.

Returns:

list of excluded authroles

Return type:

list[str]

property exclude_me

If True, the broker was asked to exclude the publisher from receiving the event.

Returns:

exclude_me flag

Return type:

None or bool

property kwargs

Keyword values for application-defined event payload.

Returns:

keyword arguments (app payload) of the event (if any)

Return type:

None or dict

marshal()

property payload

Alternative, transparent payload. If given, args and kwargs must be left unset.

Returns:

Transparent binary payload (see enc_algo) if applicable

Return type:

None or bytes

property publication

WAMP publication ID that was assigned by the broker.

Returns:

publication ID

Return type:

int

property publisher

WAMP session ID of the publisher.

Returns:

publisher ID

Return type:

int

property retain

If True, the broker was requested to retain this event.

Returns:

retain flag

Return type:

None or bool

property timestamp

Timestamp when the publication was accepted by the broker. Epoch time in ns.

Returns:

epoch time in ns

Return type:

int

property topic

The WAMP or application URI of the PubSub topic the event was published to.

Returns:

topic (URI) published to

Return type:

str

class Publications(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb.MapOidFlatBuffers

Persisted publications archive.

Map zlmdb.MapOidFlatBuffers from publication to cfxdb.eventstore.Publication.

class _Publication

Bases: cfxdb.gen.realmstore.Publication.Publication

Expand methods on the class code generated by flatc.

FIXME: comes up with a PR for flatc to generated this stuff automatically.

ArgsAsBytes()

EncKeyAsBytes()

classmethod GetRootAsPublication(buf, offset)

This method is deprecated. Please switch to GetRootAs.

KwargsAsBytes()

PayloadAsBytes()