src/dbus/qdbusconnectioninterface.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDBus module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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 QT_MODULE(DBus)
  57
  58 class QDBusConnection;
  59 class QString;
  60 class QByteArray;
  61
  62 /*
  63  * Proxy class for interface org.freedesktop.DBus
  64  */
  65 class 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
  77 public:
  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
  93 public 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
 107 Q_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 &);
 119 protected:
 120     void connectNotify(const char *);
 121     void disconnectNotify(const char *);
 122 #endif
 123 };
 124
 125 QT_END_NAMESPACE
 126
 127 Q_DECLARE_BUILTIN_METATYPE(QDBusConnectionInterface::RegisterServiceReply, UInt)
 128
 129 QT_END_HEADER
 130
 131 #endif // QT_NO_DBUS
 132 #endif