En esta página

QCoapMessage Class

La clase `QCoapMessage` contiene información sobre un mensaje CoAP, que puede ser una solicitud o una respuesta. Más información...

Encabezado: #include <QCoapMessage>
CMake: find_package(Qt6 REQUIRED COMPONENTS Coap)
target_link_libraries(mytarget PRIVATE Qt6::Coap)
qmake: QT += coap
Heredado por:

QCoapRequest

Nota: Todas las funciones de esta clase son reentrantes.

Tipos públicos

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

Funciones públicas

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)

Descripción detallada

Contiene información como el tipo de mensaje, el identificador del mensaje, el token y otros datos complementarios.

Véase también QCoapOption, QCoapReply y QCoapRequest.

Documentación sobre los tipos de miembros

enum class QCoapMessage::Type

Indica el tipo de mensaje.

ConstanteValorDescripción
QCoapMessage::Type::Confirmable0Un mensaje confirmable. El punto final de destino debe acusar recibo del mensaje.
QCoapMessage::Type::NonConfirmable1Un mensaje no confirmable. El punto final de destino no tiene que acusar recibo del mensaje.
QCoapMessage::Type::Acknowledgment2Un mensaje de acuse de recibo. Un mensaje enviado o recibido en respuesta a un mensaje confirmable.
QCoapMessage::Type::Reset3Un mensaje de reinicio. Este tipo de mensaje se utiliza en caso de errores o para detener la transmisión en curso. (Por ejemplo, se utiliza para cancelar una observación).

Documentación de las funciones miembro

QCoapMessage::QCoapMessage()

Crea un nuevo objeto QCoapMessage.

QCoapMessage::QCoapMessage(const QCoapMessage &other)

Crea una copia superficial de ` other`.

[noexcept] QCoapMessage::~QCoapMessage()

Destruye el « QCoapMessage ».

void QCoapMessage::addOption(const QCoapOption &option)

Añade el option CoAP indicado.

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

Añade la opción CoAP con los valores indicados en « name » y « value ».

Se trata de una función sobrecargada.

void QCoapMessage::clearOptions()

Elimina todas las opciones.

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

Devuelve « true » si el mensaje contiene al menos una opción con « name ».

quint16 QCoapMessage::messageId() const

Devuelve el identificador del mensaje.

Véase también setMessageId().

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

Busca y devuelve la primera opción con el valor « name » indicado. Si no existe dicha opción, devuelve un « QCoapOption » no válido con un valor vacío.

QCoapOption QCoapMessage::optionAt(int index) const

Devuelve la opción situada en la posición « index ».

int QCoapMessage::optionCount() const

Devuelve el número de opciones.

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

Devuelve la lista de opciones.

Véase también ` setOptions()`.

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

Busca y devuelve la lista de opciones con el ` name` indicado.

QByteArray QCoapMessage::payload() const

Devuelve la carga útil.

Véase también setPayload().

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

Elimina todas las opciones con el « name » indicado. El protocolo CoAP permite que se repita la misma opción.

void QCoapMessage::removeOption(const QCoapOption &option)

Elimina el « option » indicado.

void QCoapMessage::setMessageId(quint16 id)

Establece el ID del mensaje en id.

Véase también messageId().

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

Establece las opciones de los mensajes en options.

Véase también options().

void QCoapMessage::setPayload(const QByteArray &payload)

Establece la carga útil del mensaje en payload. La carga útil puede representarse en uno de los formatos de contenido definidos en el Registro de formatos de contenido de CoAP.

Nota: CoAP admite formatos de contenido comunes como XML, JSON, etc., pero estos se basan en texto y, por lo tanto, son pesados tanto en cuanto a la carga útil como al procesamiento. Uno de los formatos de contenido recomendados para su uso con CoAP es CBOR, que está diseñado para utilizarse en este tipo de contextos.

Véase también payload(), QCborStreamWriter y QCborStreamReader.

void QCoapMessage::setToken(const QByteArray &token)

Establece el token del mensaje en token.

Véase también token().

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

Establece el tipo de mensaje en « type ».

Véase también type().

void QCoapMessage::setVersion(quint8 version)

Establece la versión de CoAP en version.

Véase también version().

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

Intercambia este mensaje con other. Esta operación es muy rápida y nunca falla.

QByteArray QCoapMessage::token() const

Devuelve el token del mensaje.

Véase también setToken().

quint8 QCoapMessage::tokenLength() const

Devuelve la longitud del token.

QCoapMessage::Type QCoapMessage::type() const

Devuelve el tipo de mensaje.

Véase también setType().

quint8 QCoapMessage::version() const

Devuelve la versión de CoAP.

Véase también setVersion().

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

Incorpora ` other ` a este mensaje y devuelve una referencia a este ` QCoapMessage`.

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

Copia el contenido de other en este mensaje. Devuelve una referencia a este 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.