1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtDBus module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QDBUSPENDINGCALL_H
41#define QDBUSPENDINGCALL_H
42
43#include <QtDBus/qtdbusglobal.h>
44#include <QtDBus/qdbusmessage.h>
45#include <QtCore/qobject.h>
46#include <QtCore/qshareddata.h>
47
48#ifndef QT_NO_DBUS
49
50QT_BEGIN_NAMESPACE
51
52
53class QDBusConnection;
54class QDBusError;
55class QDBusPendingCallWatcher;
56
57class QDBusPendingCallPrivate;
58class Q_DBUS_EXPORT QDBusPendingCall
59{
60public:
61 QDBusPendingCall(const QDBusPendingCall &other);
62 ~QDBusPendingCall();
63 QDBusPendingCall &operator=(QDBusPendingCall &&other) noexcept { swap(other); return *this; }
64 QDBusPendingCall &operator=(const QDBusPendingCall &other);
65
66 void swap(QDBusPendingCall &other) noexcept { qSwap(d, other.d); }
67
68#ifndef Q_CLANG_QDOC
69 // pretend that they aren't here
70 bool isFinished() const;
71 void waitForFinished();
72
73 bool isError() const;
74 bool isValid() const;
75 QDBusError error() const;
76 QDBusMessage reply() const;
77#endif
78
79 static QDBusPendingCall fromError(const QDBusError &error);
80 static QDBusPendingCall fromCompletedCall(const QDBusMessage &message);
81
82protected:
83 QExplicitlySharedDataPointer<QDBusPendingCallPrivate> d;
84 friend class QDBusPendingCallPrivate;
85 friend class QDBusPendingCallWatcher;
86 friend class QDBusConnection;
87
88 QDBusPendingCall(QDBusPendingCallPrivate *dd);
89
90private:
91 QDBusPendingCall(); // not defined
92};
93
94Q_DECLARE_SHARED(QDBusPendingCall)
95
96class QDBusPendingCallWatcherPrivate;
97class Q_DBUS_EXPORT QDBusPendingCallWatcher: public QObject, public QDBusPendingCall
98{
99 Q_OBJECT
100public:
101 explicit QDBusPendingCallWatcher(const QDBusPendingCall &call, QObject *parent = nullptr);
102 ~QDBusPendingCallWatcher();
103
104#ifdef Q_QDOC
105 // trick qdoc into thinking this method is here
106 bool isFinished() const;
107#endif
108 void waitForFinished(); // non-virtual override
109
110Q_SIGNALS:
111 void finished(QDBusPendingCallWatcher *self = nullptr);
112
113private:
114 Q_DECLARE_PRIVATE(QDBusPendingCallWatcher)
115 Q_PRIVATE_SLOT(d_func(), void _q_finished())
116};
117
118QT_END_NAMESPACE
119
120#endif // QT_NO_DBUS
121#endif
122