PySide6.QtDBus.QDBusPendingCall¶

class QDBusPendingCall¶

The QDBusPendingCall class refers to one pending asynchronous call.

Details

A QDBusPendingCall object is a reference to a method call that was sent over D-Bus without waiting for a reply. QDBusPendingCall is an opaque type, meant to be used as a handle for a pending reply.

In most programs, the QDBusPendingCall class will not be used directly. It can be safely replaced with the template-based QDBusPendingReply , in order to access the contents of the reply or wait for it to be complete.

The QDBusPendingCallWatcher class allows one to connect to a signal that will indicate when the reply has arrived or if the call has timed out. It also provides the waitForFinished() method which will suspend the execution of the program until the reply has arrived.

Note

If you create a copy of a QDBusPendingCall object, all information will be shared among the many copies. Therefore, QDBusPendingCall is an explicitly-shared object and does not provide a method of detaching the copies (since they refer to the same pending call)

Synopsis¶

Methods¶

def __init__()
def error()
def isError()
def isFinished()
def isValid()
def reply()
def swap()
def waitForFinished()

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

__init__(other)¶

Parameters:: other – QDBusPendingCall

Creates a copy of the other pending asynchronous call. Note that both objects will refer to the same pending call.

error()¶

Return type:: QDBusError

static fromCompletedCall(message)¶

Parameters:: message – QDBusMessage
Return type:: QDBusPendingCall

Creates a QDBusPendingCall object based on the message msg. The message must be of type ErrorMessage or ReplyMessage (that is, a message that is typical of a completed call).

This function is useful for code that requires simulating a pending call, but that has already finished.

See also

fromError()

static fromError(error)¶

Parameters:: error – QDBusError
Return type:: QDBusPendingCall

Creates a QDBusPendingCall object based on the error condition error. The resulting pending call object will be in the “finished” state and QDBusPendingReply <Types…>::isError() will return true.

See also

fromCompletedCall()

isError()¶

Return type:: bool

isFinished()¶

Return type:: bool

isValid()¶

Return type:: bool

reply()¶

Return type:: QDBusMessage

swap(other)¶

Parameters:: other – QDBusPendingCall

Swaps this pending call instance with other. This operation is very fast and never fails.

waitForFinished()¶