PySide6.QtMqtt.QMqttMessage¶

class QMqttMessage¶

The QMqttMessage class provides information about a message received from a message broker based on a subscription. More…

Synopsis¶

Properties¶

duplicateᅟ - This property holds whether the message is a duplicate
idᅟ - This property holds the ID of the message
payloadᅟ - This property holds the payload of a message
qosᅟ - This property holds the QoS level of a message
retainᅟ - This property holds whether the message has been retained
topicᅟ - This property holds the topic of a message

Methods¶

def __init__()
def duplicate()
def id()
def __eq__()
def payload()
def publishProperties()
def qos()
def retain()
def topic()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

An MQTT message is created inside the module and returned via the messageReceived() signal.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property duplicateᅟ: bool¶

This property holds This property holds whether the message is a duplicate..

Duplicate messages indicate that the message has been sent earlier, but it has not been confirmed yet. Hence, the broker assumes that it needs to resend to verify the transport of the message itself. Duplicate messages can only occur if the QoS level is one or two.

Access functions:

duplicate()

property idᅟ: int¶

This property holds This property holds the ID of the message..

IDs are used for messages with a QoS level above zero.

Access functions:

id()

property payloadᅟ: QByteArray¶

This property holds This property holds the payload of a message..

Access functions:

payload()

property qosᅟ: int¶

This property holds This property holds the QoS level of a message..

Access functions:

qos()

property retainᅟ: bool¶

This property holds This property holds whether the message has been retained..

A retained message is kept on the broker for future clients to subscribe. Consequently, a retained message has been created previously and is not a live update. A broker can store only one retained message per topic.

Access functions:

retain()

property topicᅟ: QMqttTopicName¶

This property holds This property holds the topic of a message..

In case a wildcard has been used for a subscription, describes the topic matching this subscription. This property never contains wildcards.

Access functions:

topic()

__init__()¶

Creates a new MQTT message.

__init__(other)

Parameters:: other – QMqttMessage

Constructs a new MQTT message that is a copy of other.

duplicate()¶

Return type:: bool

Getter of property duplicateᅟ .

id()¶

Return type:: int

Getter of property idᅟ .

__eq__(other)¶

Parameters:: other – QMqttMessage
Return type:: bool

Returns true if the message and other are equal, otherwise returns false.

payload()¶

Return type:: QByteArray

Getter of property payloadᅟ .

publishProperties()¶

Return type:: QMqttPublishProperties

Returns the publish properties received as part of the message.

Note

This function only specifies the properties when a publish message is received. Messages with a QoS value of 1 or 2 can contain additional properties when a message is released. Those can be obtained by the messageStatusChanged signal.

Note

This function will only provide valid data when the client specifies MQTT_5_0 as ProtocolVersion .

qos()¶

Return type:: int

Getter of property qosᅟ .

retain()¶

Return type:: bool

Getter of property retainᅟ .

topic()¶

Return type:: QMqttTopicName

Getter of property topicᅟ .