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()も参照してください 。