1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QDBUSBUS_H
43#define QDBUSBUS_H
44
45#include <QtCore/qstringlist.h>
46
47#include <QtDBus/qdbusabstractinterface.h>
48#include <QtDBus/qdbusreply.h>
49
50#ifndef QT_NO_DBUS
51
52QT_BEGIN_HEADER
53
54QT_BEGIN_NAMESPACE
55
56QT_MODULE(DBus)
57
58class QDBusConnection;
59class QString;
60class QByteArray;
61
62/*
63 * Proxy class for interface org.freedesktop.DBus
64 */
65class Q_DBUS_EXPORT QDBusConnectionInterface: public QDBusAbstractInterface
66{
67 Q_OBJECT
68 Q_ENUMS(ServiceQueueOptions ServiceReplacementOptions RegisterServiceReply)
69 friend class QDBusConnectionPrivate;
70 static inline const char *staticInterfaceName();
71
72 explicit QDBusConnectionInterface(const QDBusConnection &connection, QObject *parent);
73 ~QDBusConnectionInterface();
74
75 Q_PROPERTY(QDBusReply<QStringList> registeredServiceNames READ registeredServiceNames)
76
77public:
78 enum ServiceQueueOptions {
79 DontQueueService,
80 QueueService,
81 ReplaceExistingService
82 };
83 enum ServiceReplacementOptions {
84 DontAllowReplacement,
85 AllowReplacement
86 };
87 enum RegisterServiceReply {
88 ServiceNotRegistered = 0,
89 ServiceRegistered,
90 ServiceQueued
91 };
92
93public Q_SLOTS:
94 QDBusReply<QStringList> registeredServiceNames() 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 char *);
121 void disconnectNotify(const char *);
122#endif
123};
124
125QT_END_NAMESPACE
126
127Q_DECLARE_BUILTIN_METATYPE(QDBusConnectionInterface::RegisterServiceReply, UInt)
128
129QT_END_HEADER
130
131#endif // QT_NO_DBUS
132#endif
133