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 を指定することで、ブローカーでのメッセージの処理方法に関する追加の引数を指定することができます。
さらに、インスタンス化されたサブスクリプションによるメッセージの受信には、サーバーによって転送または適応されたパブリッシュプロパティが含まれている場合があります。
注:パブリッシュ プロパティは MQTT 5.0 仕様の一部であり、それより低いプロトコルレベルで接続する場合は使用できません。詳細については、QMqttClient::ProtocolVersion を参照してください。
メンバ型のドキュメント
enum QMqttPublishProperties::PublishPropertyDetail
flags QMqttPublishProperties::PublishPropertyDetails
この列挙型は、メッセージの作成時にサーバーまたはクライアントによって設定される利用可能なプロパティを指定します。
| 定数 | 定数 | 説明 |
|---|---|---|
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> の typedef です。これは、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 へのメッセージ送信に使用するトピックエイリアスを設定します。トピックエイリアスの値は、0 より大きく、サーバーで指定された最大トピックエイリアス値より小さくなければなりません。
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()も参照してください 。
© 2026 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.