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 QDBUSCONNECTIONINTERFACE_H
41#define QDBUSCONNECTIONINTERFACE_H
42
43#include <QtDBus/qtdbusglobal.h>
44#include <QtCore/qstringlist.h>
45
46#include <QtDBus/qdbusabstractinterface.h>
47#include <QtDBus/qdbusreply.h>
48
49#ifndef QT_NO_DBUS
50
51QT_BEGIN_NAMESPACE
52
53
54class QDBusConnection;
55class QString;
56class QByteArray;
57
58/*
59 * Proxy class for interface org.freedesktop.DBus
60 */
61class Q_DBUS_EXPORT QDBusConnectionInterface: public QDBusAbstractInterface
62{
63 Q_OBJECT
64 friend class QDBusConnectionPrivate;
65 static inline const char *staticInterfaceName();
66
67 explicit QDBusConnectionInterface(const QDBusConnection &connection, QObject *parent);
68 ~QDBusConnectionInterface();
69
70 Q_PROPERTY(QDBusReply<QStringList> registeredServiceNames READ registeredServiceNames)
71 Q_PROPERTY(QDBusReply<QStringList> activatableServiceNames READ activatableServiceNames)
72
73public:
74 enum ServiceQueueOptions {
75 DontQueueService,
76 QueueService,
77 ReplaceExistingService
78 };
79 Q_ENUM(ServiceQueueOptions)
80 enum ServiceReplacementOptions {
81 DontAllowReplacement,
82 AllowReplacement
83 };
84 Q_ENUM(ServiceReplacementOptions)
85 enum RegisterServiceReply {
86 ServiceNotRegistered = 0,
87 ServiceRegistered,
88 ServiceQueued
89 };
90 Q_ENUM(RegisterServiceReply)
91
92public Q_SLOTS:
93 QDBusReply<QStringList> registeredServiceNames() const;
94 QDBusReply<QStringList> activatableServiceNames() const;
95 QDBusReply<bool> isServiceRegistered(const QString &serviceName) const;
96 QDBusReply<QString> serviceOwner(const QString &name) const;
97 QDBusReply<bool> unregisterService(const QString &serviceName);
98 QDBusReply<QDBusConnectionInterface::RegisterServiceReply> registerService(const QString &serviceName,
99 ServiceQueueOptions qoption = DontQueueService,
100 ServiceReplacementOptions roption = DontAllowReplacement);
101
102 QDBusReply<uint> servicePid(const QString &serviceName) const;
103 QDBusReply<uint> serviceUid(const QString &serviceName) const;
104
105 QDBusReply<void> startService(const QString &name);
106
107Q_SIGNALS:
108 void serviceRegistered(const QString &service);
109 void serviceUnregistered(const QString &service);
110 void serviceOwnerChanged(const QString &name, const QString &oldOwner, const QString &newOwner);
111 void callWithCallbackFailed(const QDBusError &error, const QDBusMessage &call);
112
113#ifndef Q_QDOC
114 // internal signals
115 // do not use
116 void NameAcquired(const QString &);
117 void NameLost(const QString &);
118 void NameOwnerChanged(const QString &, const QString &, const QString &);
119protected:
120 void connectNotify(const QMetaMethod &) override;
121 void disconnectNotify(const QMetaMethod &) override;
122#endif
123};
124
125QT_END_NAMESPACE
126
127Q_DECLARE_BUILTIN_METATYPE(UInt, QMetaType::UInt, QDBusConnectionInterface::RegisterServiceReply)
128
129#endif // QT_NO_DBUS
130#endif
131