QCoapResource Class

The QCoapResource class holds information about a discovered resource. More...

Header: #include <QCoapResource>
CMake: find_package(Qt6 REQUIRED COMPONENTS Coap)
target_link_libraries(mytarget PRIVATE Qt6::Coap)
qmake: QT += coap

Note: All functions in this class are reentrant.

Public Functions

QCoapResource(const QCoapResource &other)
uint contentFormat() const
QHostAddress host() const
QString interface() const
int maximumSize() const
bool observable() const
QString path() const
QString resourceType() const
void setContentFormat(uint contentFormat)
void setHost(const QHostAddress &host)
void setInterface(const QString &interface)
void setMaximumSize(int maximumSize)
void setObservable(bool observable)
void setPath(const QString &path)
void setResourceType(const QString &resourceType)
void setTitle(const QString &title)
void swap(QCoapResource &other)
QString title() const
QCoapResource &operator=(const QCoapResource &other)

Detailed Description

The QCoapRequest contains data as the path and title of the resource and other ancillary information.

See also QCoapResourceDiscoveryReply.

Member Function Documentation


Constructs a new QCoapResource.

QCoapResource::QCoapResource(const QCoapResource &other)

Constructs a new CoAP resource as a copy of other, making the two resources identical.

[noexcept] QCoapResource::~QCoapResource()

Destroy the QCoapResource.

uint QCoapResource::contentFormat() const

Returns the Content-Format code of the resource.

The Content-Format code corresponds to the 'ct' attribute and provides a hint about the Content-Formats this resource returns. It is specified in RFC 7252.

See also setContentFormat().

QHostAddress QCoapResource::host() const

Returns the host of the resource.

See also setHost().

QString QCoapResource::interface() const

Returns the interface description of the resource.

The Interface Description 'if' attribute is an opaque string used to provide a name or URI indicating a specific interface definition used to interact with the target resource. It is specified in RFC 6690.

See also setInterface().

int QCoapResource::maximumSize() const

Returns the maximum size of the resource.

The maximum size estimate attribute 'sz' gives an indication of the maximum size of the resource representation returned by performing a GET on the target URI. It is specified in RFC 6690.

See also setMaximumSize().

bool QCoapResource::observable() const

Returns true if the resource is observable

See also setObservable().

QString QCoapResource::path() const

Returns the path of the resource.

See also setPath().

QString QCoapResource::resourceType() const

Returns the type of the resource.

See also setResourceType().

void QCoapResource::setContentFormat(uint contentFormat)

Sets the content format of the resource to contentFormat. The content format can be one of the content formats defined in CoAP Content-Formats Registry.

Note: CoAP supports common content formats such as XML, JSON, and so on, but these are text based and consequently heavy both in payload and in processing. One of the recommended content formats to use with CoAP is CBOR, which is designed to be used in such contexts.

See also contentFormat(), QCborStreamWriter, and QCborStreamReader.

void QCoapResource::setHost(const QHostAddress &host)

Sets the host of the resource to host.

See also host().

void QCoapResource::setInterface(const QString &interface)

Sets the interface of the resource to interface.

See also interface().

void QCoapResource::setMaximumSize(int maximumSize)

Sets the maximum size of the resource to maximumSize.

See also maximumSize().

void QCoapResource::setObservable(bool observable)

Makes the resource observable if the observable parameter is true.

See also observable().

void QCoapResource::setPath(const QString &path)

Sets the path of the resource to path.

See also path().

void QCoapResource::setResourceType(const QString &resourceType)

Sets the resource type to resourceType.

See also resourceType().

void QCoapResource::setTitle(const QString &title)

Sets the title of the resource to title.

See also title().

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

Swaps this resource with other. This operation is very fast and never fails.

QString QCoapResource::title() const

Returns the title of the resource.

See also setTitle().

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

Copies other into this resource, making the two resources identical. Returns a reference to this QCoapResource.

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