class QMqttConnectionProperties#

The QMqttConnectionProperties class represents configuration options a QMqttClient can pass to the server when invoking connectToHost() . More…

Inherited by: QMqttServerConnectionProperties

Synopsis#

Methods#

def __init__()
def authenticationData()
def authenticationMethod()
def maximumPacketSize()
def maximumReceive()
def maximumTopicAlias()
def requestProblemInformation()
def requestResponseInformation()
def sessionExpiryInterval()
def setAuthenticationData()
def setAuthenticationMethod()
def setMaximumPacketSize()
def setMaximumReceive()
def setMaximumTopicAlias()
def setRequestProblemInformation()
def setRequestResponseInformation()
def setSessionExpiryInterval()
def setUserProperties()
def userProperties()

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

Connection 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__(arg__1)#

Parameters:: arg__1 – QMqttConnectionProperties

__init__()

authenticationData()#

Return type:: QByteArray

Returns the authentication data.

See also

setAuthenticationData()

authenticationMethod()#

Return type:: str

Returns the authentication method.

See also

setAuthenticationMethod()

maximumPacketSize()#

Return type:: int

Returns the maximum packet size the client can receive.

See also

setMaximumPacketSize()

maximumReceive()#

Return type:: int

Returns the maximum amount of QoS 1 and QoS 2 publications that the client (when obtained from connectionProperties() ) or the server (when obtained from serverConnectionProperties() ) is willing to process concurrently for this session.

See also

setMaximumReceive()

maximumTopicAlias()#

Return type:: int

Returns the maximum topic alias ID the client can use.

See also

setMaximumTopicAlias()

requestProblemInformation()#

Return type:: bool

Returns whether the client should receive problem information.

See also

setRequestProblemInformation()

requestResponseInformation()#

Return type:: bool

Returns whether the client should receive response information.

See also

setRequestResponseInformation()

sessionExpiryInterval()#

Return type:: int

Returns the session expiry interval.

See also

setSessionExpiryInterval()

setAuthenticationData(authData)#

Parameters:: authData – QByteArray

Sets the authentication data to authData.

Authentication data can only be used if an authentication method has been specified.

See also

authenticationData() authenticationMethod()

setAuthenticationMethod(authMethod)#

Parameters:: authMethod – str

Sets the authentication method to authMethod.

See also

authenticationMethod() authenticationData()

setMaximumPacketSize(packetSize)#

Parameters:: packetSize – int

Sets the maximum packet size to packetSize. The maximum packet size specifies the maximum size one packet can contain. This includes the packet header and its properties.

If no maximum packet size is specified, no limit is imposed beyond the limitations of the protocol itself.

See also

maximumPacketSize()

setMaximumReceive(maximumReceive)#

Parameters:: maximumReceive – int

Sets the maximum amount of QoS 1 and QoS 2 publications that the client is willing to process concurrently for this session to maximumReceive.

A maximum receive value of 0 is not allowed.

See also

maximumReceive()

setMaximumTopicAlias(alias)#

Parameters:: alias – int

Sets the maximum topic alias to alias. The maximum topic alias specifies the highest value that the client will accept from the server. The client uses this value to limit the number of topic aliases it is willing to hold for the connection.

The default value is 0. 0 indicates that the client does not accept any topic aliases on this connection.

See also

maximumTopicAlias()

setRequestProblemInformation(problem)#

Parameters:: problem – bool

Sets the request problem information to problem. A client uses this to request the server to return additional information in case of failure. Types of failure include connection and message management on the server side.

The default value is false, which indicates that the client must not receive any problem information for anything but connection management. The server still may send problem information for connection handling. If the value is true, the server may return problem information.

Problem information is available in user properties or reason strings of the property classes.

See also

requestProblemInformation()

setRequestResponseInformation(response)#

Parameters:: response – bool

Sets the request response information to response. A client uses this to request the server to return response information after the connection request has been handled.

The default value is false, which indicates that the client must not return any response information. If the value is true, the server may return response information, but is not enforced to do so.

See also

requestResponseInformation()

setSessionExpiryInterval(expiry)#

Parameters:: expiry – int

Sets the session expiry interval to expiry. The session expiry interval specifies the number of seconds a server holds information on the client state after a connection has been closed.

The default value is 0, which specifies that the session is closed when the network connection ends. If the value is specified as maximum of quint32, then the session does not expire.

See also

sessionExpiryInterval()

setUserProperties(properties)#

Parameters:: properties – QMqttUserProperties

Sets the user properties of the connection to properties.

The default value is to not send any user information.

See also

userProperties()

userProperties()#

Return type:: QMqttUserProperties

Returns the user properties for the connection.

See also

setUserProperties()