このページでは

QCoapMessage Class

QCoapMessage クラスは、リクエストまたは応答となる CoAP メッセージに関する情報を保持します。詳細...

ヘッダー: #include <QCoapMessage>
CMake: find_package(Qt6 REQUIRED COMPONENTS Coap)
target_link_libraries(mytarget PRIVATE Qt6::Coap)
qmake: QT += coap
継承元:

QCoapRequest

注:このクラスのすべての関数は再入可能である。

パブリック型

enum class Type { Confirmable, NonConfirmable, Acknowledgment, Reset }

パブリック関数

QCoapMessage()
QCoapMessage(const QCoapMessage &other)
~QCoapMessage()
void addOption(const QCoapOption &option)
void addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray())
void clearOptions()
bool hasOption(QCoapOption::OptionName name) const
quint16 messageId() const
QCoapOption option(QCoapOption::OptionName name) const
QCoapOption optionAt(int index) const
int optionCount() const
const QList<QCoapOption> &options() const
QList<QCoapOption> options(QCoapOption::OptionName name) const
QByteArray payload() const
void removeOption(QCoapOption::OptionName name)
void removeOption(const QCoapOption &option)
void setMessageId(quint16 id)
void setOptions(const QList<QCoapOption> &options)
void setPayload(const QByteArray &payload)
void setToken(const QByteArray &token)
void setType(const QCoapMessage::Type &type)
void setVersion(quint8 version)
void swap(QCoapMessage &other)
QByteArray token() const
quint8 tokenLength() const
QCoapMessage::Type type() const
quint8 version() const
QCoapMessage &operator=(QCoapMessage &&other)
QCoapMessage &operator=(const QCoapMessage &other)

詳細な説明

メッセージタイプ、メッセージ ID、トークン、その他の補助データなどの情報を保持します。

QCoapOption 、QCoapReply 、およびQCoapRequestも参照してください 。

メンバ型のドキュメント

enum class QCoapMessage::Type

メッセージのタイプを示します。

定数値説明
QCoapMessage::Type::Confirmable0確認可能なメッセージ。宛先エンドポイントは、メッセージの受信確認を行う必要があります。
QCoapMessage::Type::NonConfirmable1確認不可のメッセージ。宛先エンドポイントは、メッセージの受信確認を行う必要はありません。
QCoapMessage::Type::Acknowledgment2確認応答メッセージ。確認可能なメッセージへの返信として送受信されるメッセージ。
QCoapMessage::Type::Reset3リセットメッセージ。このメッセージタイプは、エラーが発生した場合や、進行中の送信を停止する場合に使用されます。(たとえば、観測をキャンセルするために使用されます)。

メンバ関数のドキュメント

QCoapMessage::QCoapMessage()

新しい QCoapMessage を作成します。

QCoapMessage::QCoapMessage(const QCoapMessage &other)

other の浅いコピーを作成します。

[noexcept] QCoapMessage::~QCoapMessage()

QCoapMessage を削除します。

void QCoapMessage::addOption(const QCoapOption &option)

指定された CoAPoption を追加します。

void QCoapMessage::addOption(QCoapOption::OptionName name, const QByteArray &value = QByteArray())

指定されたname およびvalue を用いて、CoAPオプションを追加します。

これはオーバーロードされた関数です。

void QCoapMessage::clearOptions()

すべてのオプションを削除します。

bool QCoapMessage::hasOption(QCoapOption::OptionName name) const

メッセージに、name が指定されたオプションが少なくとも1つ含まれている場合、true を返します。

quint16 QCoapMessage::messageId() const

メッセージ ID を返します。

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

QCoapOption QCoapMessage::option(QCoapOption::OptionName name) const

指定されたname を持つ最初のオプションを検索して返します。そのようなオプションが存在しない場合は、値が空の無効なQCoapOption を返します。

QCoapOption QCoapMessage::optionAt(int index) const

index の位置にあるオプションを返します。

int QCoapMessage::optionCount() const

オプションの数を返します。

const QList<QCoapOption> &QCoapMessage::options() const

オプションのリストを返します。

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

QList<QCoapOption> QCoapMessage::options(QCoapOption::OptionName name) const

指定されたname を持つオプションのリストを検索して返します。

QByteArray QCoapMessage::payload() const

ペイロードを返します。

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

void QCoapMessage::removeOption(QCoapOption::OptionName name)

指定されたname を持つすべてのオプションを削除します。CoAPプロトコルでは、同じオプションが重複して指定されることがあります。

void QCoapMessage::removeOption(const QCoapOption &option)

指定されたoption を削除します。

void QCoapMessage::setMessageId(quint16 id)

メッセージIDをid に設定します。

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

void QCoapMessage::setOptions(const QList<QCoapOption> &options)

メッセージオプションを「options 」に設定します。

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

void QCoapMessage::setPayload(const QByteArray &payload)

メッセージのペイロードをpayload に設定します。ペイロードは、CoAPコンテンツ形式レジストリで定義されているコンテンツ形式のいずれかで表現できます。

注:CoAPは XMLやJSONなどの一般的なコンテンツ形式をサポートしていますが、これらはテキストベースであるため、ペイロードのサイズも処理負荷も大きくなります。CoAPでの使用が推奨されるコンテンツ形式の一つにCBORがあり、これはそのような状況での使用を想定して設計されています。

関連項目:payload()、QCborStreamWriter 、およびQCborStreamReaderも参照してください 。

void QCoapMessage::setToken(const QByteArray &token)

メッセージトークンを `token` に設定します。

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

void QCoapMessage::setType(const QCoapMessage::Type &type)

メッセージタイプを「type 」に設定します。

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

void QCoapMessage::setVersion(quint8 version)

CoAPのバージョンをversion に設定します。

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

[noexcept] void QCoapMessage::swap(QCoapMessage &other)

このメッセージを「other 」と入れ替えます。この操作は非常に高速で、失敗することはありません。

QByteArray QCoapMessage::token() const

メッセージトークンを返します。

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

quint8 QCoapMessage::tokenLength() const

トークンの長さを返します。

QCoapMessage::Type QCoapMessage::type() const

メッセージのタイプを返します。

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

quint8 QCoapMessage::version() const

CoAPのバージョンを返します。

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

[noexcept] QCoapMessage &QCoapMessage::operator=(QCoapMessage &&other)

other をこのメッセージに移動し、このQCoapMessage への参照を返します。

QCoapMessage &QCoapMessage::operator=(const QCoapMessage &other)

other の内容をこのメッセージにコピーします。このQCoapMessage への参照を返します。

© 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.