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

#include <qdbuspendingcall.h>

Inheritance diagram for QDBusPendingCallWatcher:

Signals
void	finished (QDBusPendingCallWatcher *self)
	This signal is emitted when the pending call has finished and its reply is available. More...

Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...

Public Functions
bool	isFinished () const
	Returns true if the pending call has finished processing and the reply has been received. More...

	QDBusPendingCallWatcher (const QDBusPendingCall &call, QObject *parent=0)
	Creates a QDBusPendingCallWatcher object to watch for replies on the asynchronous pending call call and sets this object's parent to parent. More...

void	waitForFinished ()
	Suspends the execution of the calling thread until the reply is received and processed. More...

	~QDBusPendingCallWatcher ()
	Destroys this object. More...

Public Functions inherited from QObject
bool	blockSignals (bool b)
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...

const QObjectList &	children () const
	Returns a list of child objects. More...

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectInfo ()
	Dumps information about signal connections, etc. More...

void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...

QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...

virtual bool	event (QEvent *)
	This virtual function receives events to an object and should return true if the event e was recognized and processed. More...

virtual bool	eventFilter (QObject , QEvent )
	Filters events if this object has been installed as an event filter for the watched object. More...

template<typename T >
T	findChild (const QString &aName=QString()) const
	Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...

void	installEventFilter (QObject *)
	Installs an event filter filterObj on this object. More...

bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false. More...

void	killTimer (int id)
	Kills the timer with timer identifier, id. More...

virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children. More...

QString	objectName () const

QObject *	parent () const
	Returns a pointer to the parent object. More...

QVariant	property (const char *name) const
	Returns the value of the object's name property. More...

Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...

void	removeEventFilter (QObject *)
	Removes an event filter object obj from this object. More...

void	setObjectName (const QString &name)

void	setParent (QObject *)
	Makes the object a child of parent. More...

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value. More...

void	setUserData (uint id, QObjectUserData *data)

bool	signalsBlocked () const
	Returns true if signals are blocked; otherwise returns false. More...

int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...

QThread *	thread () const
	Returns the thread in which the object lives. More...

QObjectUserData *	userData (uint id) const

virtual	~QObject ()
	Destroys the object, deleting all its child objects. More...

Public Functions inherited from QDBusPendingCall
QDBusPendingCall &	operator= (const QDBusPendingCall &other)
	Creates a copy of the other pending asynchronous call and drops the reference to the previously-referenced call. More...

	QDBusPendingCall (const QDBusPendingCall &other)
	Creates a copy of the other pending asynchronous call. More...

	~QDBusPendingCall ()
	Destroys this copy of the QDBusPendingCall object. More...

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...

Static Public Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	Disconnects signal in object sender from method in object receiver. More...

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

static QString	tr (const char sourceText, const char comment=0, int n=-1)

static QString	trUtf8 (const char sourceText, const char comment=0, int n=-1)

Static Public Functions inherited from QDBusPendingCall
static QDBusPendingCall	fromCompletedCall (const QDBusMessage &message)
	Creates a QDBusPendingCall object based on the message msg. More...

static QDBusPendingCall	fromError (const QDBusError &error)
	Creates a QDBusPendingCall object based on the error condition error. More...

Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...

Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...

virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...

virtual void	customEvent (QEvent *)
	This event handler can be reimplemented in a subclass to receive custom events. More...

virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...

	QObject (QObjectPrivate &dd, QObject *parent=0)

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal. More...

QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *)
	This event handler can be reimplemented in a subclass to receive timer events for the object. More...

Protected Functions inherited from QDBusPendingCall
	QDBusPendingCall (QDBusPendingCallPrivate *dd)

Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Variables inherited from QDBusPendingCall
QExplicitlySharedDataPointer< QDBusPendingCallPrivate >	d

Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject

Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()

T *	qobject_cast (QObject *object)

	QObjectList

void *	qt_find_obj_child (QObject parent, const char type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

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

Attention: Module: QtDBus

Since: 4.5

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.

See also: QDBusPendingReply, QDBusAbstractInterface::asyncCall()

Definition at line 99 of file qdbuspendingcall.h.

Constructors and Destructors

◆ QDBusPendingCallWatcher()

QDBusPendingCallWatcher::QDBusPendingCallWatcher	(	const QDBusPendingCall &	call,
		QObject *	parent = `0`
	)

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

Definition at line 529 of file qdbuspendingcall.cpp.

     : QObject(*new QDBusPendingCallWatcherPrivate, parent), QDBusPendingCall(call)
 {
     if (d) {                    // QDBusPendingCall::d
         QMutexLocker locker(&d->mutex);
         if (!d->watcherHelper) {
             d->watcherHelper = new QDBusPendingCallWatcherHelper;
             if (d->replyMessage.type() != QDBusMessage::InvalidMessage) {
                 // cause a signal emission anyways
                 QMetaObject::invokeMethod(d->watcherHelper, "finished", Qt::QueuedConnection);
             }
         }
         d->watcherHelper->add(this);
     }
 }

◆ ~QDBusPendingCallWatcher()

QDBusPendingCallWatcher::~QDBusPendingCallWatcher ( )

Destroys this object.

If this QDBusPendingCallWatcher object was the last reference to the unfinished pending call, the call will be canceled.

Definition at line 550 of file qdbuspendingcall.cpp.

551 {

552 }

Functions

◆ finished

void QDBusPendingCallWatcher::finished ( QDBusPendingCallWatcher * self )

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.

◆ isFinished()

bool QDBusPendingCallWatcher::isFinished ( ) const

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

◆ waitForFinished()

void QDBusPendingCallWatcher::waitForFinished ( )

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

Definition at line 567 of file qdbuspendingcall.cpp.

 {
     if (d) {
         d->waitForFinished();
 
         // our signals were queued, so deliver them
         QCoreApplication::sendPostedEvents(d->watcherHelper, QEvent::MetaCall);
         QCoreApplication::sendPostedEvents(this, QEvent::MetaCall);
     }
 }

The documentation for this class was generated from the following files:

/src/dbus/qdbuspendingcall.h
/src/dbus/qdbuspendingcall.cpp

Signals

Public Functions

Additional Inherited Members