Home · All Classes · Modules

QDBusPendingCallWatcher Class Reference
^{[QtDBus module]}

The QDBusPendingCallWatcher class provides a convenient way for waiting for asynchronous replies More...

Inherits QObject and QDBusPendingCall.

Methods

• __init__ (self, QDBusPendingCall call, QObject parent = None)
• bool isFinished (self)
• waitForFinished (self)

Qt Signals

• void finished (QDBusPendingCallWatcher*)

The QDBusPendingCallWatcher provides the finished() signal that will be emitted when a reply arrives.

It is usually used like the following example:

     QDBusPendingCall async = iface->asyncCall("RemoteMethod", value1, value2);
     QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(async, this);

     QObject.connect(watcher, SIGNAL(finished(QDBusPendingCallWatcher*)),
                      this, SLOT(callFinishedSlot(QDBusPendingCallWatcher*)));

Note that it is not necessary to keep the original QDBusPendingCall object around since QDBusPendingCallWatcher inherits from that class too.

The slot connected to by the above code could be something similar to the following:

 void MyClass.callFinishedSlot(QDBusPendingCallWatcher *call)
 {
     QDBusPendingReply<QString, QByteArray> reply = *call;
     if (reply.isError()) {
         showError();
     } else {
         QString text = reply.argumentAt<0>();
         QByteArray data = reply.argumentAt<1>();
         showReply(text, data);
     }
     call->deleteLater();
 }

Note the use of QDBusPendingReply to validate the argument types in the reply. If the reply did not contain exactly two arguments (one string and one QByteArray), QDBusPendingReply.isError() will return true.

Method Documentation

QDBusPendingCallWatcher.__init__ (self, QDBusPendingCall call, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Creates a QDBusPendingCallWatcher object to watch for replies on the asynchronous pending call call and sets this object's parent to parent.

bool QDBusPendingCallWatcher.isFinished (self)

Returns true if the pending call has finished processing and the reply has been received.

Note that this function only changes state if you call waitForFinished() or if an external D-Bus event happens, which in general only happens if you return to the event loop execution.

See also QDBusPendingReply.isFinished().

QDBusPendingCallWatcher.waitForFinished (self)

Suspends the execution of the calling thread until the reply is received and processed. After this function returns, isFinished() should return true, indicating the reply's contents are ready to be processed.

See also QDBusPendingReply.waitForFinished().

Qt Signal Documentation

void finished (QDBusPendingCallWatcher*)

This is the default overload of this signal.

This signal is emitted when the pending call has finished and its reply is available. The self parameter is a pointer to the object itself, passed for convenience so that the slot can access the properties and determine the contents of the reply.