PySide6.QtMqtt.QMqttSubscriptionProperties

class QMqttSubscriptionProperties

The QMqttSubscriptionProperties class represents configuration options a QMqttClient can pass to the server when subscribing to a topic filter. More…

Synopsis

Methods

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

Note

Subscription properties are part of the MQTT 5.0 specification and cannot be used when connecting with a lower protocol level. See ProtocolVersion for more information.

__init__()
__init__(arg__1)
Parameters:

arg__1 – QMqttSubscriptionProperties

noLocal()
Return type:

bool

Returns true if the subscription shall not receive local messages on the same topic.

See also

setNoLocal()

setNoLocal(noloc)
Parameters:

noloc – bool

Sets the subscription option to not receive local message. When a client publishes a message with the same topic as an existing local subscription the server by default sends the message back to the client. If noloc is set to true the broker will not send any message the same client has published.

See also

noLocal()

setSubscriptionIdentifier(id)
Parameters:

id – int

Sets the subscription identifier to id.

setUserProperties(user)
Parameters:

user – QMqttUserProperties

Sets the user properties to user.

See also

userProperties()

subscriptionIdentifier()
Return type:

int

Returns the subscription identifier used to describe this subscription.

userProperties()
Return type:

QMqttUserProperties

Returns the user specified properties.