QMqtt Namespace
Qt MQTT モジュール全体で使用される雑多な識別子が含まれています。詳細...
Header: | #include <QMqtt> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
qmake: | QT += mqtt |
型
enum class | MessageStatus { Unknown, Published, Acknowledged, Received, Released, Completed } |
enum class | PayloadFormatIndicator { Unspecified, UTF8Encoded } |
enum class | ReasonCode { Success, SubscriptionQoSLevel0, SubscriptionQoSLevel1, SubscriptionQoSLevel2, NoMatchingSubscriber, …, WildCardSubscriptionsNotSupported } |
タイプ ドキュメンテーション
enum class QMqtt::MessageStatus
この列挙型は、メッセージの利用可能な状態を指定する。クライアントのQoSや役割に応じて、異なるメッセージ状態が期待される。
定数 | 値 | 説明 |
---|---|---|
QMqtt::MessageStatus::Unknown | 0 | メッセージ・ステータスは不明です。 |
QMqtt::MessageStatus::Published | 1 | クライアントは、そのサブスクリプションの 1 つに対するメッセージを受信しました。これは QoS レベル 1 と 2 に適用されます。 |
QMqtt::MessageStatus::Acknowledged | 2 | メッセージが確認されました。これは QoS 1 に適用され、クライアント側からのメッセージ処理が終了したことを示します。 |
QMqtt::MessageStatus::Received | 3 | メッセージが受信されました。これは QoS 2 に適用される。 |
QMqtt::MessageStatus::Released | 4 | メッセージがリリースされました。これは QoS 2 に適用される。 |
QMqtt::MessageStatus::Completed | 5 | メッセージが完了した。これは QoS 2 に適用され、クライアント側からのメッセージ処理が 終了したことを示す。 |
enum class QMqtt::PayloadFormatIndicator
ペイロード形式はメッセージの内容に関する情報を提供する。これは他のクライアントがより速くメッセージを処理するのに役立ちます。
定数 | 値 | 説明 |
---|---|---|
QMqtt::PayloadFormatIndicator::Unspecified | 0 | フォーマットは指定されません。 |
QMqtt::PayloadFormatIndicator::UTF8Encoded | 1 | メッセージのペイロードは UTF-8 Encoded Character Data としてフォーマットされる。 |
enum class QMqtt::ReasonCode
この列挙型は利用可能なエラーコードを指定する。
定数 | 値 | 説明 |
---|---|---|
QMqtt::ReasonCode::Success | 0 | 指定されたアクションは成功しました。 |
QMqtt::ReasonCode::SubscriptionQoSLevel0 | 0 | QoS レベル 0 のサブスクリプションが作成されました。 |
QMqtt::ReasonCode::SubscriptionQoSLevel1 | 0x01 | QoS レベル 1 のサブスクリプションが作成されました。 |
QMqtt::ReasonCode::SubscriptionQoSLevel2 | 0x02 | QoS レベル 2 のサブスクリプションが作成されました。 |
QMqtt::ReasonCode::NoMatchingSubscriber | 0x10 | メッセージはサーバーによって受け入れられたが、このメッセージを受信 するサブスクライバーが存在しない。ブローカは Success の代わりにこの理由コードを送るかもしれない。 |
QMqtt::ReasonCode::NoSubscriptionExisted (since Qt 5.15) | 0x11 | 一致するトピックフィルタがクライアントによって使用されていません。 |
QMqtt::ReasonCode::ContinueAuthentication (since Qt 5.15) | 0x18 | 別の手順で認証を続行してください。 |
QMqtt::ReasonCode::ReAuthenticate (since Qt 5.15) | 0x19 | 再認証を開始します。 |
QMqtt::ReasonCode::UnspecifiedError | 0x80 | 特定できないエラーが発生した。 |
QMqtt::ReasonCode::MalformedPacket | 0x81 | サーバーに送信されたパケットが無効です。 |
QMqtt::ReasonCode::ProtocolError | 0x82 | プロトコルエラーが発生しました。ほとんどの場合、これによってサーバはクライアントを切断する。 |
QMqtt::ReasonCode::ImplementationSpecificError | 0x83 | パケットは有効だが、受信者が拒否した。 |
QMqtt::ReasonCode::UnsupportedProtocolVersion | 0x84 | 要求されたプロトコルのバージョンがサーバーでサポートされていない。 |
QMqtt::ReasonCode::InvalidClientId | 0x85 | クライアントIDが無効である。 |
QMqtt::ReasonCode::InvalidUserNameOrPassword | 0x86 | 指定されたユーザー名またはパスワードが無効です。 |
QMqtt::ReasonCode::NotAuthorized | 0x87 | クライアントが指定されたアクションを許可されていない。 |
QMqtt::ReasonCode::ServerNotAvailable | 0x88 | 接続先のサーバーが利用できません。 |
QMqtt::ReasonCode::ServerBusy | 0x89 | 接続先のサーバーが利用できません。クライアントは、後日接続を試みるように要求されます。 |
QMqtt::ReasonCode::ClientBanned | 0x8A | クライアントがサーバーから禁止されています。 |
QMqtt::ReasonCode::InvalidAuthenticationMethod | 0x8C | 指定された認証方法が無効です。 |
QMqtt::ReasonCode::InvalidTopicFilter | 0x8F | 指定されたトピックフィルタが無効です。 |
QMqtt::ReasonCode::InvalidTopicName | 0x90 | 指定されたトピック名が無効です。 |
QMqtt::ReasonCode::MessageIdInUse | 0x91 | 前のパケットで使用されたメッセージIDがすでに使用されている。 |
QMqtt::ReasonCode::MessageIdNotFound | 0x92 | 前のパケットで使用されたメッセージIDが見つかりません。 |
QMqtt::ReasonCode::PacketTooLarge | 0x95 | 受信したパケットが大きすぎる。QMqttServerConnectionProperties::maximumPacketSize()も参照のこと。 |
QMqtt::ReasonCode::QuotaExceeded | 0x97 | 管理上の制限を超えました。 |
QMqtt::ReasonCode::InvalidPayloadFormat | 0x99 | ペイロードの形式が無効である。QMqttPublishProperties::payloadFormatIndicator() も参照してください。 |
QMqtt::ReasonCode::RetainNotSupported | 0x9A | サーバーが保持メッセージに対応していません。QMqttServerConnectionProperties::retainAvailable() も参照してください。 |
QMqtt::ReasonCode::QoSNotSupported | 0x9B | 要求された QoS レベルがサポートされていません。QMqttServerConnectionProperties::maximumQoS()も参照。 |
QMqtt::ReasonCode::UseAnotherServer | 0x9C | クライアントが接続しようとしたサーバは使用できません。QMqttServerConnectionProperties::serverReference() も参照してください。 |
QMqtt::ReasonCode::ServerMoved | 0x9D | クライアントが接続しようとしたサーバーが新しいアドレスに移動しました。QMqttServerConnectionProperties::serverReference() も参照してください。 |
QMqtt::ReasonCode::SharedSubscriptionsNotSupported | 0x9E | 共有サブスクリプションはサポートされていません。QMqttServerConnectionProperties::sharedSubscriptionSupported() も参照してください。 |
QMqtt::ReasonCode::ExceededConnectionRate | 0x9F | 接続率の制限を超えました。 |
QMqtt::ReasonCode::SubscriptionIdsNotSupported | 0xA1 | サブスクリプション ID はサポートされていません。QMqttServerConnectionProperties::subscriptionIdentifierSupported() も参照してください。 |
QMqtt::ReasonCode::WildCardSubscriptionsNotSupported | 0xA2 | ワイルドカードを使用したサブスクリプションはサポートされていません。QMqttServerConnectionProperties::wildcardSupported() も参照してください。 |
すべてのユースケースですべての値が使用できるわけではありません。特に、特定のコマンドに適さない理由コードを拒否するサーバーもあります。特定のアクションで期待される理由コードは以下の表を参照。
理由コード | 接続プロパティ | サブスクリプションのプロパティ | メッセージのプロパティ |
---|---|---|---|
成功 | X | X | X |
サブスクリプションQoSLevel0 | X | ||
サブスクリプションQoSLevel1 | X | ||
サブスクリプションQoSLレベル2 | X | ||
サブスクライバーの一致なし | X | ||
特定できないエラー | X | X | X |
不正パケット | X | ||
プロトコルエラー | X | ||
実装固有のエラー | X | X | X |
サポートされていないプロトコルバージョン | X | ||
無効なクライアントID | X | ||
無効なユーザー名またはパスワード | X | ||
未承認 | X | X | X |
サーバー使用不可 | X | ||
サーバー使用中 | X | ||
クライアント禁止 | X | ||
無効な認証方法 | X | ||
無効なトピックフィルタ | X | ||
無効なトピック名 | X | X | |
MessageIdInUse | X | X | |
MessageIdNotFound | X | ||
パケットが大きすぎる | X | ||
クォータ超過 | X | X | X |
無効なペイロードフォーマット | X | X | |
サポートされていない保持 | X | ||
QoSNotSupported | X | ||
別のサーバーを使用 | X | ||
サーバー移動 | X | ||
共有サブスクリプション非サポート | X | ||
接続レート超過 | X | ||
サポートされていないサブスクリプションID | X | ||
サポートされていないワイルドカード・サブスクリプション | X |
©2024 The Qt Company Ltd. 本文書に含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。