1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 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 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QDBUSCONNECTION_H

    43 #define QDBUSCONNECTION_H

    44 

    45 #include <QtDBus/qdbusmacros.h>

    46 #include <QtCore/qstring.h>

    47 

    48 QT_BEGIN_HEADER

    49 

    50 QT_BEGIN_NAMESPACE

    51 

    52 QT_MODULE(DBus)

    53 

    54 namespace QDBus

    55 {

    56     enum CallMode {

    57         NoBlock,

    58         Block,

    59         BlockWithGui,

    60         AutoDetect

    61     };

    62 }

    63 

    64 class QDBusAbstractInterfacePrivate;

    65 class QDBusInterface;

    66 class QDBusError;

    67 class QDBusMessage;

    68 class QDBusPendingCall;

    69 class QDBusConnectionInterface;

    70 class QObject;

    71 

    72 class QDBusConnectionPrivate;

    73 class QDBUS_EXPORT QDBusConnection

    74 {

    75     Q_GADGET

    76     Q_ENUMS(BusType UnregisterMode)

    77     Q_FLAGS(RegisterOptions)

    78 public:

    79     enum BusType { SessionBus, SystemBus, ActivationBus };

    80     enum RegisterOption {

    81         ExportAdaptors = 0x01,

    82 

    83         ExportScriptableSlots = 0x10,

    84         ExportScriptableSignals = 0x20,

    85         ExportScriptableProperties = 0x40,

    86         ExportScriptableContents = 0xf0,

    87 

    88         ExportNonScriptableSlots = 0x100,

    89         ExportNonScriptableSignals = 0x200,

    90         ExportNonScriptableProperties = 0x400,

    91         ExportNonScriptableContents = 0xf00,

    92 

    93         ExportAllSlots = ExportScriptableSlots|ExportNonScriptableSlots,

    94         ExportAllSignals = ExportScriptableSignals|ExportNonScriptableSignals,

    95         ExportAllProperties = ExportScriptableProperties|ExportNonScriptableProperties,

    96         ExportAllContents = ExportScriptableContents|ExportNonScriptableContents,

    97 

    98 #ifndef Q_QDOC

    99         // Qt 4.2 had a misspelling here

   100         ExportAllSignal = ExportAllSignals,

   101 #endif

   102 

   103         ExportChildObjects = 0x1000

   104     };

   105     enum UnregisterMode {

   106         UnregisterNode,

   107         UnregisterTree

   108     };

   109 

   110     Q_DECLARE_FLAGS(RegisterOptions, RegisterOption)

   111 

   112     QDBusConnection(const QString &name);

   113     QDBusConnection(const QDBusConnection &other);

   114     ~QDBusConnection();

   115 

   116     QDBusConnection &operator=(const QDBusConnection &other);

   117 

   118     bool isConnected() const;

   119     QString baseService() const;

   120     QDBusError lastError() const;

   121     QString name() const;

   122 

   123     bool send(const QDBusMessage &message) const;

   124     bool callWithCallback(const QDBusMessage &message, QObject *receiver,

   125                           const char *returnMethod, const char *errorMethod,

   126                           int timeout = -1) const;

   127     bool callWithCallback(const QDBusMessage &message, QObject *receiver,

   128                           const char *slot, int timeout = -1) const;

   129     QDBusMessage call(const QDBusMessage &message, QDBus::CallMode mode = QDBus::Block,

   130                       int timeout = -1) const;

   131     QDBusPendingCall asyncCall(const QDBusMessage &message, int timeout = -1) const;

   132 

   133     bool connect(const QString &service, const QString &path, const QString &interface,

   134                  const QString &name, QObject *receiver, const char *slot);

   135     bool disconnect(const QString &service, const QString &path, const QString &interface,

   136                     const QString &name, QObject *receiver, const char *slot);

   137 

   138     bool connect(const QString &service, const QString &path, const QString &interface,

   139                  const QString &name, const QString& signature,

   140                  QObject *receiver, const char *slot);

   141     bool disconnect(const QString &service, const QString &path, const QString &interface,

   142                     const QString &name, const QString& signature,

   143                     QObject *receiver, const char *slot);

   144 

   145     bool registerObject(const QString &path, QObject *object,

   146                         RegisterOptions options = ExportAdaptors);

   147     void unregisterObject(const QString &path, UnregisterMode mode = UnregisterNode);

   148     QObject *objectRegisteredAt(const QString &path) const;

   149 

   150     bool registerService(const QString &serviceName);

   151     bool unregisterService(const QString &serviceName);

   152 

   153     QDBusConnectionInterface *interface() const;

   154 

   155     static QDBusConnection connectToBus(BusType type, const QString &name);

   156     static QDBusConnection connectToBus(const QString &address, const QString &name);

   157     static void disconnectFromBus(const QString &name);

   158 

   159     static QDBusConnection sessionBus();

   160     static QDBusConnection systemBus();

   161 

   162     static QDBusConnection sender();

   163 

   164 protected:

   165     explicit QDBusConnection(QDBusConnectionPrivate *dd);

   166 

   167 private:

   168     friend class QDBusConnectionPrivate;

   169     QDBusConnectionPrivate *d;

   170 };

   171 

   172 Q_DECLARE_OPERATORS_FOR_FLAGS(QDBusConnection::RegisterOptions)

   173 

   174 QT_END_NAMESPACE

   175 

   176 QT_END_HEADER

   177 

   178 #endif