QMqttConnectionProperties Class

メンバ関数のドキュメント

QByteArray QMqttConnectionProperties::authenticationData() const

認証データを返します。

setAuthenticationData()も参照してください 。

QString QMqttConnectionProperties::authenticationMethod() const

認証メソッドを返します。

setAuthenticationMethod()も参照してください 。

quint32 QMqttConnectionProperties::maximumPacketSize() const

クライアントが受信できる最大パケットサイズを返します。

setMaximumPacketSize()も参照してください 。

quint16 QMqttConnectionProperties::maximumReceive() const

クライアント（QMqttClient::connectionProperties() から取得した場合）またはサーバー（QMqttClient::serverConnectionProperties() から取得した場合）が、このセッションにおいて同時に処理できる QoS 1 および QoS 2 パブリケーションの最大数を返します。

setMaximumReceive()も参照してください 。

quint16 QMqttConnectionProperties::maximumTopicAlias() const

クライアントが使用できるトピックエイリアスIDの最大値を返します。

setMaximumTopicAlias()も参照してください 。

bool QMqttConnectionProperties::requestProblemInformation() const

クライアントが問題情報を受信すべきかどうかを返します。

setRequestProblemInformation()も参照してください 。

bool QMqttConnectionProperties::requestResponseInformation() const

クライアントが応答情報を受け取るべきかどうかを返します。

setRequestResponseInformation()も参照してください 。

quint32 QMqttConnectionProperties::sessionExpiryInterval() const

セッションの有効期限間隔を返します。

setSessionExpiryInterval()も参照してください 。

void QMqttConnectionProperties::setAuthenticationData(const QByteArray &authData)

認証データを `authData` に設定します。

認証データは、認証方法が指定されている場合にのみ使用できます。

authenticationData() およびauthenticationMethod()も参照してください 。

void QMqttConnectionProperties::setAuthenticationMethod(const QString &authMethod)

認証方法を `authMethod` に設定します。

authenticationMethod() およびauthenticationData()も参照してください 。

void QMqttConnectionProperties::setMaximumPacketSize(quint32 packetSize)

パケットの最大サイズをpacketSize に設定します。パケットの最大サイズとは、1つのパケットが含むことができる最大サイズを指します。これには、パケットヘッダーとそのプロパティも含まれます。

最大パケットサイズが指定されていない場合、プロトコル自体の制限以外に制限は課されません。

maximumPacketSize()も参照してください 。

void QMqttConnectionProperties::setMaximumReceive(quint16 maximumReceive)

このセッションにおいて、クライアントが同時に処理できるQoS 1およびQoS 2のパブリケーションの最大数を、maximumReceive に設定します。

受信の上限値を 0 に設定することはできません。

maximumReceive()も参照してください 。

void QMqttConnectionProperties::setMaximumTopicAlias(quint16 alias)

トピックエイリアスの最大数を `alias` に設定します。トピックエイリアスの最大数は、クライアントがサーバーから受け入れる最大値を指定します。クライアントはこの値を使用して、その接続に対して保持するトピックエイリアスの数を制限します。

デフォルト値は 0 です。0 は、クライアントがこの接続においてトピックエイリアスを一切受け入れないことを示します。

maximumTopicAlias()も参照してください 。

void QMqttConnectionProperties::setRequestProblemInformation(bool problem)

リクエストの問題情報を `problem` に設定します。クライアントはこれを使用して、障害発生時にサーバーに追加情報の返送を要求します。障害の種類には、サーバー側の接続およびメッセージ管理に関するものが含まれます。

デフォルト値は `false` であり、これはクライアントが接続管理以外の問題情報を受け取ってはならないことを示します。ただし、サーバーは接続処理に関する問題情報を送信する場合があります。値が `true` の場合、サーバーは問題情報を返すことがあります。

問題情報は、ユーザープロパティまたはプロパティクラスの理由文字列で利用可能です。

requestProblemInformation()も参照してください 。

void QMqttConnectionProperties::setRequestResponseInformation(bool response)

リクエストの応答情報を `response` に設定します。クライアントはこれを使用して、接続リクエストが処理された後に、サーバーに応答情報を返すよう要求します。

デフォルト値はfalse であり、これはクライアントが応答情報を一切返してはならないことを示します。値がtrue の場合、サーバーは応答情報を返すことができますが、そうしなければならないという義務はありません。

requestResponseInformation()も参照してください 。

void QMqttConnectionProperties::setSessionExpiryInterval(quint32 expiry)

セッションの有効期限をexpiry に設定します。セッションの有効期限は、接続が切断された後、サーバーがクライアントの状態に関する情報を保持する秒数を指定します。

デフォルト値は 0 で、これはネットワーク接続が終了した時点でセッションが閉じられることを指定します。値が quint32 の最大値として指定された場合、セッションは期限切れになりません。

sessionExpiryInterval()も参照してください 。

void QMqttConnectionProperties::setUserProperties(const QMqttUserProperties &properties)

properties への接続のユーザープロパティを設定します。

デフォルトでは、ユーザー情報は送信されません。

userProperties()も参照してください 。

QMqttUserProperties QMqttConnectionProperties::userProperties() const

接続のユーザープロパティを返します。

setUserProperties()も参照してください 。