PySide6.QtCoap.QCoapResource

class QCoapResource

The QCoapResource class holds information about a discovered resource. More

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

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

__init__()

Constructs a new QCoapResource .

__init__(other)
Parameters:

otherQCoapResource

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

contentFormat()
Return type:

int

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 .

host()
Return type:

QHostAddress

Returns the host of the resource.

See also

setHost()

interface()
Return type:

str

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

maximumSize()
Return type:

int

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

observable()
Return type:

bool

Returns true if the resource is observable

See also

setObservable()

path()
Return type:

str

Returns the path of the resource.

See also

setPath()

resourceType()
Return type:

str

Returns the type of the resource.

setContentFormat(contentFormat)
Parameters:

contentFormat – int

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

setHost(host)
Parameters:

hostQHostAddress

Sets the host of the resource to host.

See also

host()

setInterface(interface)
Parameters:

interface – str

Sets the interface of the resource to interface.

See also

interface()

setMaximumSize(maximumSize)
Parameters:

maximumSize – int

Sets the maximum size of the resource to maximumSize.

See also

maximumSize()

setObservable(observable)
Parameters:

observable – bool

Makes the resource observable if the observable parameter is true.

See also

observable()

setPath(path)
Parameters:

path – str

Sets the path of the resource to path.

See also

path()

setResourceType(resourceType)
Parameters:

resourceType – str

Sets the resource type to resourceType.

See also

resourceType()

setTitle(title)
Parameters:

title – str

Sets the title of the resource to title.

See also

title()

swap(other)
Parameters:

otherQCoapResource

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

title()
Return type:

str

Returns the title of the resource.

See also

setTitle()