QMqttPublishProperties Class
QMqttPublishProperties クラスは、メッセージの送受信に関する設定オプションを表します。詳細...
| Header: | #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
メッセージのトピック・フィルタにマッチするサブスクリプションの ID を返します。
setSubscriptionIdentifiers() も参照して ください。
quint16 QMqttPublishProperties::topicAlias() const
メッセージの発行に使用されたトピック・エイリアスを返します。
setTopicAlias() も参照して ください。
QMqttUserProperties QMqttPublishProperties::userProperties() const
メッセージのユーザ・プロパティを返します。
setUserProperties() も参照して ください。
©2024 The Qt Company Ltd. 本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
