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