src/dbus/qdbuspendingcall_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDBus module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the public API.  This header file may
  47 // change from version to version without notice, or even be
  48 // removed.
  49 //
  50 // We mean it.
  51 //
  52 //
  53
  54 #ifndef QDBUSPENDINGCALL_P_H
  55 #define QDBUSPENDINGCALL_P_H
  56
  57 #include <qshareddata.h>
  58 #include <qpointer.h>
  59 #include <qvector.h>
  60 #include <qmutex.h>
  61 #include <qwaitcondition.h>
  62
  63 #include "qdbusmessage.h"
  64 #include "qdbus_symbols_p.h"
  65
  66 #ifndef QT_NO_DBUS
  67
  68 QT_BEGIN_NAMESPACE
  69
  70 class QDBusPendingCall;
  71 class QDBusPendingCallWatcher;
  72 class QDBusPendingCallWatcherHelper;
  73 class QDBusConnectionPrivate;
  74
  75 class QDBusPendingCallPrivate: public QSharedData
  76 {
  77 public:
  78     // {
  79     //     set only during construction:
  80     const QDBusMessage sentMessage;
  81     QDBusConnectionPrivate * const connection;
  82
  83     // for the callback mechanism (see setReplyCallback and QDBusConnectionPrivate::sendWithReplyAsync)
  84     QPointer<QObject> receiver;
  85     QVector<int> metaTypes;
  86     int methodIdx;
  87
  88     bool autoDelete;
  89     // }
  90
  91     mutable QMutex mutex;
  92     QWaitCondition waitForFinishedCondition;
  93
  94     // {
  95     //    protected by the mutex above:
  96     QDBusPendingCallWatcherHelper *watcherHelper;
  97     QDBusMessage replyMessage;
  98     DBusPendingCall *pending;
  99     volatile bool waitingForFinished;
 100
 101     QString expectedReplySignature;
 102     int expectedReplyCount;
 103     // }
 104
 105     QDBusPendingCallPrivate(const QDBusMessage &sent, QDBusConnectionPrivate *connection)
 106         : sentMessage(sent), connection(connection), autoDelete(false), watcherHelper(0), pending(0), waitingForFinished(false)
 107     { }
 108     ~QDBusPendingCallPrivate();
 109     bool setReplyCallback(QObject *target, const char *member);
 110     void waitForFinished();
 111     void setMetaTypes(int count, const int *types);
 112     void checkReceivedSignature();
 113
 114     static QDBusPendingCall fromMessage(const QDBusMessage &msg);
 115 };
 116
 117 class QDBusPendingCallWatcherHelper: public QObject
 118 {
 119     Q_OBJECT
 120 public:
 121     void add(QDBusPendingCallWatcher *watcher);
 122
 123     void emitSignals(const QDBusMessage &replyMessage, const QDBusMessage &sentMessage)
 124     {
 125         if (replyMessage.type() == QDBusMessage::ReplyMessage)
 126             emit reply(replyMessage);
 127         else
 128             emit error(QDBusError(replyMessage), sentMessage);
 129         emit finished();
 130     }
 131
 132 Q_SIGNALS:
 133     void finished();
 134     void reply(const QDBusMessage &msg);
 135     void error(const QDBusError &error, const QDBusMessage &msg);
 136 };
 137
 138 QT_END_NAMESPACE
 139
 140 #endif // QT_NO_DBUS
 141 #endif