QMqttClient Class

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

[explicit] QMqttClient::QMqttClient(QObject *parent = nullptr)

指定されたparent を使用して、新しいMQTTクライアントインスタンスを作成します。

[override virtual noexcept] QMqttClient::~QMqttClient()

MQTTクライアントを削除します。MQTTクライアントがまだMQTTブローカーから切断されていない場合は、自動的に切断されます。

void QMqttClient::authenticate(const QMqttAuthenticationProperties &prop)

ブローカーに認証リクエストを送信します。prop は、認証リクエストを処理するために必要な情報を指定します。

この関数は、QMqttClient::authenticationRequested シグナルが発行された後にのみ呼び出す必要があります。

authenticationRequested() およびauthenticationFinished()も参照してください 。

[signal] void QMqttClient::authenticationFinished(const QMqttAuthenticationProperties &p)

このシグナルは、拡張認証が完了した後に発せられます。p には、認証プロセスに関する利用可能な詳細情報が指定されています。

認証が成功すると、QMqttClient::connected が送信されます。

authenticationRequested() およびauthenticate()も参照してください 。

[signal] void QMqttClient::authenticationRequested(const QMqttAuthenticationProperties &p)

このシグナルは、クライアントが `QMqttClient::connectToHost ` または `QMqttClient::connectToHostEncrypted ` を呼び出した後、接続が確立される前に発行されます。拡張認証では、ブローカーが追加情報の提供を要求する場合があり、その場合は `QMqttClient::authenticate` を呼び出して情報を提供する必要があります。p は、ブローカーによって提供されるプロパティを指定します。

authenticationFinished() およびauthenticate()も参照してください 。

[signal] void QMqttClient::brokerSessionRestored()

このシグナルは、クライアントがcleanSession プロパティをfalse に設定してブローカーへの接続に成功し、ブローカーがセッションを復元した後に発行されます。

クライアントが以前に同じclientId を使用して接続していた場合、セッションを復元することができます。

[invokable] void QMqttClient::connectToHost()

MQTTブローカーへの接続を開始します。

void QMqttClient::connectToHostEncrypted(const QSslConfiguration &conf)

MQTTブローカーへの暗号化された接続を開始します。

conf 接続に使用するSSL設定を指定します

[invokable, since 6.10] void QMqttClient::connectToHostWebSocket(QWebSocket *webSocket = nullptr)

WebSocketトランスポートタイプを設定し、MQTTブローカーへの接続を開始します。以前のトランスポートタイプは上書きされます。webSocket が指定された場合、ホスト名とポートは無視され、そのWebSocketを使用して接続が行われます。webSocketは呼び出し元のコードが所有しており、QMqttClient オブジェクトの存続期間中は有効でなければなりません。

この関数は Qt 6.10 で導入されました。

[invokable, since 6.10] void QMqttClient::connectToHostWebSocketEncrypted(QWebSocket *webSocket = nullptr)

セキュアなWebSocketトランスポートタイプを設定し、MQTTブローカーへの接続を開始します。以前のトランスポートタイプは上書きされます。webSocket が指定された場合、ホスト名とポートは無視され、そのWebSocketを使用して接続が行われます。webSocketは呼び出し元のコードが所有しており、QMqttClient オブジェクトの存続期間中、有効である必要があります。

この関数は Qt 6.10 で導入されました。

[signal] void QMqttClient::connected()

この信号は、接続が確立されたときに送信されます。

QMqttConnectionProperties QMqttClient::connectionProperties() const

クライアントがブローカーに要求した接続プロパティを返します。

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

[invokable] void QMqttClient::disconnectFromHost()

MQTTブローカーから切断します。

[signal] void QMqttClient::disconnected()

このシグナルは、接続が閉じられたときに発信されます。接続は、disconnectFromHost() が呼び出されたとき、またはブローカーが接続を切断したときに閉じられることがあります。

QMqttLastWillProperties QMqttClient::lastWillProperties() const

最後の「will」プロパティを返します。

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

[signal] void QMqttClient::messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName())

このシグナルは、新しいメッセージを受信した際に発せられます。メッセージのカテゴリは `topic ` で指定され、内容は `message` となります。

[signal] void QMqttClient::messageSent(qint32 id)

publish() 関数を通じて送信されたメッセージが、ブローカーによって受信されたことを示します。id は、メッセージのステータスを追跡しやすくするため、publish() が返すものと同じです。

[signal] void QMqttClient::messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties)

このシグナルは、id で識別されるメッセージのステータスが変更されたときに発信されます。s はメッセージの新しいステータスを指定し、properties はサーバーから提供される追加のプロパティを指定します。

[signal] void QMqttClient::pingResponseReceived()

このシグナルは、ブローカーがrequestPing()の呼び出しまたはkeepAlive()のpingメッセージに応答した後、接続が依然として有効な場合に発せられます。

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

指定されたtopic を使用して、message をブローカーに発行します。qos は、メッセージの転送に必要なQoSレベルを指定します。

retain がtrue に設定されている場合、メッセージはブローカー上に残り、他のクライアントが接続してメッセージを受信できるようになります。

メッセージを識別するために内部で使用される ID を返します。

[invokable] qint32 QMqttClient::publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties, const QByteArray &message = QByteArray(), quint8 qos = 0, bool retain = false)

指定されたproperties およびtopic を使用して、message をブローカーに公開します。qos は、メッセージの転送に必要なQoSレベルを指定します。

retain がtrue に設定されている場合、メッセージはブローカー上に残り、他のクライアントが接続してそのメッセージを受信できるようになります。

メッセージを識別するために内部で使用される ID を返します。

bool QMqttClient::requestPing()

ブローカーにpingメッセージを送信し、応答を待ちます。

接続がアクティブで、autoKeepAlive がtrue に設定されている場合、このプロセスの管理はクライアントの責任となるため、この関数の呼び出しは失敗します。

requestPing() を手動で使用する場合、接続がアクティブな限り、keepAlive の間隔ごとに毎回呼び出しを行う必要があります。

ping が成功したかどうかを確認するには、pingResponseReceived() シグナルに接続します。

ping リクエストを送信できた場合は、true を返します。

pingResponseReceived()、autoKeepAlive()、およびkeepAlive()も参照してください 。

QMqttServerConnectionProperties QMqttClient::serverConnectionProperties() const

接続試行後にブローカーから返されたQMqttServerConnectionProperties を返します。

これにより、QMqttClient::setConnectionProperties で設定されたクライアント側の接続プロパティがブローカーによって受け入れられたかどうかを確認できます。また、接続試行が失敗した場合は、接続の診断にも利用できます。

「connectionProperties()」も参照してください 。

void QMqttClient::setConnectionProperties(const QMqttConnectionProperties &prop)

接続プロパティをprop に設定します。QMqttConnectionProperties を使用すると、サーバーに対して特定の機能セットを使用するよう要求できます。接続要求の後、QMqttClient::serverConnectionProperties を呼び出すことでサーバーの応答を取得できます。

「connectionProperties()」も参照してください 。

void QMqttClient::setLastWillProperties(const QMqttLastWillProperties &prop)

「last will」のプロパティを「prop 」に設定します。「QMqttLastWillProperties 」を使用すると、ブローカーに保存される「last will」メッセージに対して追加機能を設定できます。

「lastWillProperties()」も参照してください 。

void QMqttClient::setTransport(QIODevice *device, QMqttClient::TransportType transport)

トランスポートをdevice に設定します。トランスポートはソケット型、またはQIODevice から派生した型であり、transport で指定されます。

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

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, quint8 qos = 0)

topic での通知を受信するための新しいサブスクリプションを追加します。パラメータqos は、セキュリティメッセージを受信するレベルを指定します。利用可能な QoS レベルの詳細については、「Quality of Service」を参照してください。

この関数は、QMqttSubscription へのポインタを返します。同じトピックを 2 回購読した場合、戻り値は同じサブスクリプションインスタンスを指します。MQTT クライアントがサブスクリプションの所有者となります。

QMqttSubscription *QMqttClient::subscribe(const QMqttTopicFilter &topic, const QMqttSubscriptionProperties &properties, quint8 qos = 0)

topic での通知を受信するための新しいサブスクリプションを追加します。パラメータ `properties ` は、ブローカーによって検証される追加のサブスクリプションプロパティを指定します。パラメータ `qos ` は、セキュリティメッセージを受信するレベルを指定します。利用可能な QoS レベルの詳細については、「Quality of Service」を参照してください。

この関数は、QMqttSubscription へのポインタを返します。同じトピックに 2 回サブスクライブされた場合、戻り値は同じサブスクリプションインスタンスを指します。MQTT クライアントは、そのサブスクリプションの所有者となります。

QIODevice *QMqttClient::transport() const

ブローカーとの通信に使用されるトランスポートを返します。

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

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic)

topic の購読を解除します。subscribe() を呼び出して登録されたどの購読に対しても、通知は送信されません。

void QMqttClient::unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties)

topic からの購読を解除します。subscribe() を呼び出して行われた購読に対しては、通知は送信されません。properties は、ブローカーに渡す追加のユーザープロパティを指定します。