QCoapMessage Class
QCoapMessageクラスは、リクエストやリプライのCoAPメッセージに関する情報を保持します。詳細...
| Header: | #include <QCoapMessage> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Coap)target_link_libraries(mytarget PRIVATE Qt6::Coap) |
| qmake: | QT += coap |
| Inherited By: |
注意:このクラスの関数はすべてリエントラントです。
パブリック型
| 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) |
QCoapOption 、QCoapReply 、QCoapRequestも参照 。
メンバ型 ドキュメント
enum class QCoapMessage::Type
メッセージのタイプを示す。
| 定数 | 値 | 説明 |
|---|---|---|
QCoapMessage::Type::Confirmable | 0 | 確認可能メッセージ。宛先エンドポイントはメッセージを確認する必要があります。 |
QCoapMessage::Type::NonConfirmable | 1 | 確認不可メッセージ。宛先エンドポイントはメッセージを確認する必要はありません。 |
QCoapMessage::Type::Acknowledgment | 2 | 確認応答メッセージ。Confirmable メッセージへの返信として送受信されるメッセージ。 |
QCoapMessage::Type::Reset | 3 | Reset メッセージ。このメッセージ・タイプは、エラーの発生時や、進行中の送信を停止する場合に使用される。(例えば、観測をキャンセルするときに使用する）。 |
メンバー関数ドキュメント
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 Content-Formats Registry で定義されているコンテンツ・フォーマットのいずれかで表現できます。
注： CoAPはXMLやJSONなどの一般的なコンテンツ・フォーマットをサポートしていますが、これらはテキスト・ベースであるため、ペイロードも処理も重くなります。CoAPで推奨されるコンテンツ・フォーマットの1つは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 への参照を返します。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
