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 設定を指定します。

[signal] void QMqttClient::connected()

このシグナルは、接続が確立されたときに発せられる。

QMqttConnectionProperties QMqttClient::connectionProperties() const

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

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

[invokable] void QMqttClient::disconnectFromHost()

MQTT ブローカとの接続を切断する。

[signal] void QMqttClient::disconnected()

このシグナルは、コネクションがクローズされたときに発行されます。コネクションがクローズされるのは、disconnectFromHost() がコールされたときか、ブローカーが切断したときです。

QMqttLastWillProperties QMqttClient::lastWillProperties() const

最後のウィルプロパティを返す。

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)

message topic 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)

prop QMqttLastWillProperties では、ブローカに保存されるラストウィルメッセージの追加機能を設定できます。

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 レベルの詳細については、QoS を参照してください。

この関数はQMqttSubscription へのポインタを返す。同じトピックが二度サブスクライブされた場合、返り値は同じサブスクリプションインスタンスを指す。MQTT クライアントはサブスクリプションのオーナーである。

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

topic で通知を受け取るための新しいサブスクリプションを追加する。パラメータproperties は、ブローカが検証する追加のサブスクリプションプロパティを指定する。パラメータqos は、セキュリティメッセージを受信するレベルを指定する。利用可能な QoS レベルの詳細については、QoS を参照のこと。

この関数はQMqttSubscription へのポインタを返す。 同じトピックが二度サブスクライブされた場合、戻り値は同じサブスクリプションイン スタンスを指す。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 は、ブローカに渡す追加のユーザープロパティを指定します。