class QCoapReply#

The QCoapReply class holds the data of a CoAP reply. More

Inheritance diagram of PySide6.QtCoap.QCoapReply

Inherited by: QCoapResourceDiscoveryReply

Synopsis#

Methods#

Signals#

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 QCoapReply contains data related to a request sent with the QCoapClient .

The finished() signal is emitted when the response is fully received or when the request fails.

For Observe requests specifically, the notified() signal is emitted whenever a notification is received.

abortRequest()#

Aborts the request immediately and emits the aborted(const QCoapToken &token) signal if the request was not finished.

aborted(token)#
Parameters:

tokenQByteArray

This signal is emitted when the request is aborted or the reply is deleted. Its token parameter is the token of the exchange that has been aborted.

Note

If the QCoapReply is deleted while not finished, both aborted() and finished() signal will be emitted immediately before the QCoapReply is destroyed. Given the QCoapReply may have been deleted when receiving the signal, you should not rely on the sender() object to be still valid.

See also

finished() error()

error(reply, error)#
Parameters:

This signal is emitted whenever an error occurs and is followed by the finished() signal.

Its reply parameters is the QCoapReply itself for convenience, and the error parameter is the error received.

errorReceived()#
Return type:

Error

Returns the error of the reply or QCoapReply::NoError if there is no error.

finished(reply)#
Parameters:

replyQCoapReply

This signal is emitted whenever the corresponding request finished, whether successfully or not. When a resource is observed, this signal will only be emitted once, when the observation ends.

The reply parameter is the QCoapReply itself for convenience.

Note

If the QCoapReply is deleted while not finished, both aborted() and finished() signal will be emitted immediately before the QCoapReply is destroyed. Given the QCoapReply may have been deleted when receiving the signal, you should not rely on the reply to be still valid.

isAborted()#
Return type:

bool

Returns true if the request has been aborted.

isFinished()#
Return type:

bool

Returns true if the request is finished.

See also

finished()

isRunning()#
Return type:

bool

Returns true if the request is running.

isSuccessful()#
Return type:

bool

Returns true if the request finished with no error.

message()#
Return type:

QCoapMessage

Returns the contained message.

method()#
Return type:

Method

Returns the method of the associated request.

notified(reply, message)#
Parameters:

This signal is emitted whenever a notification is received from an observed resource.

Its message parameter is a QCoapMessage containing the payload and the message details. The reply parameter is the QCoapReply itself for convenience.

request()#
Return type:

QCoapRequest

Returns the associated request.

responseCode()#
Return type:

ResponseCode

Returns the response code of the request.

url()#
Return type:

QUrl

Returns the target uri of the associated request.