summaryrefslogtreecommitdiff
path: root/qt/qdbusconnection.h
blob: dc3eb47a97cc99d003ca9f0ef9d7dd946cdb4c97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/* qdbusconnection.h QDBusConnection object
 *
 * Copyright (C) 2005 Harald Fernengel <harry@kdevelop.org>
 * Copyright (C) 2006 Trolltech AS. All rights reserved.
 *    Author: Thiago Macieira <thiago.macieira@trolltech.com>
 *
 * Licensed under the Academic Free License version 2.1
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef QDBUSCONNECTION_H
#define QDBUSCONNECTION_H

#include "qdbusmacros.h"
#include <QtCore/qstring.h>

class QDBusConnectionPrivate;
class QDBusXmlParser;
class QDBusObject;
class QDBusInterface;
class QDBusError;
class QDBusMessage;
class QByteArray;
class QObject;

class QDBUS_EXPORT QDBusConnection
{
public:
    enum BusType { SessionBus, SystemBus, ActivationBus };
    enum NameRequestMode { NoReplace = 0, ProhibitReplace = 1, ReplaceExisting = 2 };
    enum RegisterOption {
        ExportAdaptors = 0x01,

        ExportSlots = 0x10,
        ExportSignals = 0x20,
        ExportProperties = 0x40,
        ExportContents = 0xf0,

        ExportNonScriptableSlots = 0x110,
        ExportNonScriptableSignals = 0x220,
        ExportNonScriptableProperties = 0x440,
        ExportNonScriptableContents = 0xff0,

        ExportChildObjects = 0x1000
    };
    enum UnregisterMode {
        UnregisterNode,
        UnregisterTree
    };

    Q_DECLARE_FLAGS(RegisterOptions, RegisterOption);

    QDBusConnection(const QString &name);
    QDBusConnection(const QDBusConnection &other);
    ~QDBusConnection();

    QDBusConnection &operator=(const QDBusConnection &other);

    bool isConnected() const;
    QString baseService() const;
    QDBusError lastError() const;

    bool send(const QDBusMessage &message) const;
    QDBusMessage sendWithReply(const QDBusMessage &message) const;
    int sendWithReplyAsync(const QDBusMessage &message, QObject *receiver,
                           const char *slot) const;

    bool connect(const QString &service, const QString &path, const QString &interface,
                 const QString &name, QObject *receiver, const char *slot);
    bool connect(const QString &service, const QString &path, const QString &interface,
                 const QString &name, const QString& signature,
                 QObject *receiver, const char *slot);

    bool registerObject(const QString &path, QObject *object,
                        RegisterOptions options = ExportAdaptors);
    void unregisterObject(const QString &path, UnregisterMode = UnregisterNode);

    QDBusObject findObject(const QString& service, const QString& path);
    QDBusInterface findInterface(const QString& service, const QString& path, const QString& interface);

#ifndef QT_NO_MEMBER_TEMPLATES
    template<class Interface>
    inline Interface findInterface(const QString &service, const QString &path)
    { return Interface(findObject(service, path)); }
#endif

    bool requestName(const QString &name, NameRequestMode mode = NoReplace);
    bool releaseName(const QString& name);
    QString getNameOwner(const QString& name);

    static QDBusConnection addConnection(BusType type,
                                         const QString &name);
    static QDBusConnection addConnection(const QString &address,
                                         const QString &name);
    static void closeConnection(const QString &name);

private:
    friend class QDBusObject;
    QDBusConnectionPrivate *d;
};

namespace QDBus {
    QDBusConnection &sessionBus();
    QDBusConnection &systemBus();
}

template<class Interface>
inline Interface qDBusConnectionFindInterface(QDBusConnection &connection, const QString &service,
                                              const QString &path)
{
    return Interface(connection.findObject(service, path));
}

Q_DECLARE_OPERATORS_FOR_FLAGS(QDBusConnection::RegisterOptions)
#endif