QMqttPublishProperties Class
QMqttPublishProperties クラスは、メッセージの送受信に関する設定オプションを表します。詳細...
ヘッダ | #include <QMqttPublishProperties> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
qmake: | QT += mqtt |
パブリックな型
enum | PublishPropertyDetail { None, PayloadFormatIndicator, MessageExpiryInterval, TopicAlias, ResponseTopic, …, ContentType } |
flags | PublishPropertyDetails |
パブリック関数
QMqttPublishProperties::PublishPropertyDetails | availableProperties() const |
QString | contentType() const |
QByteArray | correlationData() const |
quint32 | messageExpiryInterval() const |
QMqtt::PayloadFormatIndicator | payloadFormatIndicator() const |
QString | responseTopic() const |
void | setContentType(const QString &type) |
void | setCorrelationData(const QByteArray &correlation) |
void | setMessageExpiryInterval(quint32 interval) |
void | setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator) |
void | setResponseTopic(const QString &topic) |
void | setSubscriptionIdentifiers(const QList<quint32> &ids) |
void | setTopicAlias(quint16 alias) |
void | setUserProperties(const QMqttUserProperties &properties) |
QList<quint32> | subscriptionIdentifiers() const |
quint16 | topicAlias() const |
QMqttUserProperties | userProperties() const |
詳細説明
ブローカにメッセージを送信するためにQMqttClient::publish() を呼び出すと、QMqttPublishProperties を含めることができ、ブローカでメッセージがどのように扱われるべきかについての追加の引数を提供することができます。
さらに、インスタンス化されたサブスクリプションによるメッセージの受信は、サーバーによって転送または適応されたパブリッシュプロパティを含むかもしれません。
注: Publish プロパティは MQTT 5.0 仕様の一部であり、より低いプロトコルレベルで接続するときは使用できない。詳細はQMqttClient::ProtocolVersion を参照のこと。
メンバ型の説明
enum QMqttPublishProperties::PublishPropertyDetail
flags QMqttPublishProperties::PublishPropertyDetails
この enum 型は、メッセージ作成時にサーバーまたはクライアントが設定する利用可能なプロパティを指定します。
定数 | 値 | 説明 |
---|---|---|
QMqttPublishProperties::None | 0x00000000 | プロパティは指定されていません。 |
QMqttPublishProperties::PayloadFormatIndicator | 0x00000001 | メッセージの内容のタイプ。 |
QMqttPublishProperties::MessageExpiryInterval | 0x00000002 | メッセージが有効な期間。 |
QMqttPublishProperties::TopicAlias | 0x00000004 | このメッセージのトピック・エイリアス。 |
QMqttPublishProperties::ResponseTopic | 0x00000008 | 受信者が応答すべきトピック。 |
QMqttPublishProperties::CorrelationData | 0x00000010 | 応答メッセージの識別子。 |
QMqttPublishProperties::UserProperty | 0x00000020 | ユーザが設定する追加プロパティ。 |
QMqttPublishProperties::SubscriptionIdentifier | 0x00000040 | パブリケーションに一致するサブスクリプションの識別子。 |
QMqttPublishProperties::ContentType | 0x00000080 | メッセージの内容の説明。 |
PublishPropertyDetails 型は、QFlags<PublishPropertyDetail> の型定義です。これは、PublishPropertyDetail値のORの組み合わせを格納します。
メンバ関数のドキュメント
QMqttPublishProperties::PublishPropertyDetails QMqttPublishProperties::availableProperties() const
このインスタンスで指定された利用可能なプロパティを返します。メッセージの作成時に、すべてのプロパティを含める必要はありません。この関数は、明示的に設定されたプロパティのインジケータとして機能します。
QString QMqttPublishProperties::contentType() const
メッセージのコンテント・タイプを返します。
setContentType()も参照 。
QByteArray QMqttPublishProperties::correlationData() const
相関データを返す。
setCorrelationData()も参照 。
quint32 QMqttPublishProperties::messageExpiryInterval() const
メッセージの有効期限間隔を返します。この値は、サーバがメッセージを転送できる秒数を指定します。この間隔が過ぎると、サーバはメッセージを削除して公開を中止しなければなりません。
setMessageExpiryInterval()も参照のこと 。
QMqtt::PayloadFormatIndicator QMqttPublishProperties::payloadFormatIndicator() const
ペイロードフォーマットインジケータを返す。
setPayloadFormatIndicator()も参照 。
QString QMqttPublishProperties::responseTopic() const
ユーザーがリクエストのフォローアップとして使うべきレスポンストピックを返します。
setResponseTopic()も参照ください 。
void QMqttPublishProperties::setContentType(const QString &type)
メッセージのコンテント・タイプをtype に設定する。
contentType()も参照のこと 。
void QMqttPublishProperties::setCorrelationData(const QByteArray &correlation)
相関データをcorrelation に設定する。
correlationData()も参照のこと 。
void QMqttPublishProperties::setMessageExpiryInterval(quint32 interval)
メッセージの有効期限間隔をinterval に設定する。
messageExpiryInterval()も参照のこと 。
void QMqttPublishProperties::setPayloadFormatIndicator(QMqtt::PayloadFormatIndicator indicator)
ペイロードフォーマットインジケータをindicator に設定する。
payloadFormatIndicator()も参照のこと 。
void QMqttPublishProperties::setResponseTopic(const QString &topic)
応答トピックをtopic に設定する。
responseTopic()も参照のこと 。
void QMqttPublishProperties::setSubscriptionIdentifiers(const QList<quint32> &ids)
サブスクリプション識別子をids に設定する。
subscriptionIdentifiers()も参照 。
void QMqttPublishProperties::setTopicAlias(quint16 alias)
alias にメッセージを公開する際のトピック・エイリアスを設定します。トピック・エイリアスの値は、ゼロより大きく、サーバが指定するトピック・エイリアスの最大値より小さくなければなりません。
topicAlias() およびQMqttServerConnectionProperties::maximumTopicAlias()も参照のこと 。
void QMqttPublishProperties::setUserProperties(const QMqttUserProperties &properties)
メッセージのユーザ・プロパティをproperties に設定する。
userProperties()も参照 。
QList<quint32> QMqttPublishProperties::subscriptionIdentifiers() const
メッセージのトピック・フィルタにマッチするサブスクリプションの識別子を返します。
setSubscriptionIdentifiers()も参照してください 。
quint16 QMqttPublishProperties::topicAlias() const
メッセージの公開に使用したトピックのエイリアスを返します。
setTopicAlias()も参照して ください。
QMqttUserProperties QMqttPublishProperties::userProperties() const
メッセージのユーザ・プロパティを返します。
setUserProperties()も参照してください 。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.