QMqttMessage#
The QMqttMessage
class provides information about a message received from a message broker based on a subscription. More…
Synopsis#
Functions#
Detailed Description#
An MQTT message is created inside the module and returned via the messageReceived()
signal.
- class PySide6.QtMqtt.QMqttMessage#
PySide6.QtMqtt.QMqttMessage(other)
- Parameters
other –
PySide6.QtMqtt.QMqttMessage
Creates a new MQTT message.
Constructs a new MQTT message that is a copy of other
.
- PySide6.QtMqtt.QMqttMessage.duplicate()#
- Return type
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.
- PySide6.QtMqtt.QMqttMessage.id()#
- Return type
quint16
This property holds This property holds the ID of the message..
IDs are used for messages with a QoS level above zero.
- PySide6.QtMqtt.QMqttMessage.__eq__(other)#
- Parameters
other –
PySide6.QtMqtt.QMqttMessage
- Return type
bool
Returns true
if the message and other
are equal, otherwise returns false
.
- PySide6.QtMqtt.QMqttMessage.payload()#
- Return type
This property holds This property holds the payload of a message..
- PySide6.QtMqtt.QMqttMessage.publishProperties()#
- Return type
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
.
- PySide6.QtMqtt.QMqttMessage.qos()#
- Return type
quint8
This property holds This property holds the QoS level of a message..
- PySide6.QtMqtt.QMqttMessage.retain()#
- Return type
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.
- PySide6.QtMqtt.QMqttMessage.topic()#
- Return type
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.