Spec-Zone.ru › Qt 6.1

Класс QCoapMessage

Класс QCoapMessage содержит информацию о сообщении CoAP, которое может быть запросом или ответом. Подробнее...

Заголовок: #include <QCoapMessage>
qmake: QT += coap
Наследуется от:

QCoapRequest

  • Список всех членов, включая унаследованные члены

Примечание: Все функции в этом классе являются взаимоисключающими.

Открытые типы

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

Открытые функции

QCoapMessage(const QCoapMessage &other)
QCoapMessage()
QCoapMessage & operator=(QCoapMessage &&other)
QCoapMessage & operator=(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(const QCoapOption &option)
void removeOption(QCoapOption::OptionName name)
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

Подробное описание

Он содержит информацию, такую как тип сообщения, идентификатор сообщения, токен и другие вспомогательные данные.

См. также QCoapOption, QCoapReply, и QCoapRequest.

Документация по типам членов

enum class QCoapMessage::Type

Указывает тип сообщения.

Константа Значение Описание
QCoapMessage::Type::Confirmable 0 Подтверждаемое сообщение. Конечная точка назначения должна подтвердить получение сообщения.
QCoapMessage::Type::NonConfirmable 1 Неподтверждаемое сообщение. Конечная точка назначения не должна подтверждать получение сообщения.
QCoapMessage::Type::Acknowledgment 2 Сообщение подтверждения. Сообщение, отправленное или полученное в ответ на подтверждаемое сообщение.
QCoapMessage::Type::Reset 3 Сообщение сброса. Этот тип сообщения используется в случае ошибок или для остановки текущей передачи. (Например, он используется для отмены наблюдения).

Документация по функциям-членам

QCoapMessage::QCoapMessage(const QCoapMessage &other)

Создает неглубокую копию other.

QCoapMessage::QCoapMessage()

Создает новый QCoapMessage.

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

Оператор присваивания перемещения.

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

Копирует содержимое other в это сообщение. Возвращает ссылку на это QCoapMessage.

QCoapMessage::~QCoapMessage()

Уничтожает QCoapMessage.

void QCoapMessage::addOption(const QCoapOption &option)

Добавляет заданный параметр CoAP option.

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

Это перегруженная функция.

Добавляет параметр CoAP с заданным name и value.

void QCoapMessage::clearOptions()

Удаляет все параметры.

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

Возвращает true если сообщение содержит хотя бы один параметр с name.

quint16 QCoapMessage::messageId() const

Возвращает идентификатор сообщения.

См. также 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(const QCoapOption &option)

Удаляет заданную опцию option.

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

Удаляет все опции с заданным именем name. Протокол CoAP допускает повторение одной и той же опции.

void QCoapMessage::setMessageId(quint16 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().

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().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.1/qcoapmessage.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API