outgoing_message_topic_alias Property

An integer used to identify the topic instead of the full topic filter in order to reduce the size of the publish packet.

Syntax

def get_outgoing_message_topic_alias(outgoing_message_index: int) -> int: ...

Default Value

0

Remarks

An integer used to identify the topic instead of the full topic filter in order to reduce the size of the publish packet.

If a non-zero topic alias is received, the client should establish a new topic alias mapping or use an existing mapping, depending on whether the outgoing_message_topic string is empty.

For details on setting topic aliases for outgoing messages, see the TopicAlias configuration setting.

Valid only for MQTT 5.

The outgoing_message_index parameter specifies the index of the item in the array. The size of the array is controlled by the outgoing_message_count property.

This property is read-only.