summaryrefslogtreecommitdiffstats
path: root/src/clientcompat/jsondb-connection_p.h
blob: 8548552f27d52002dbae68c4fd54e56368a8703b (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
130
131
132
133
134
135
136
137
138
139
140
141
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtAddOn.JsonDb module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef JSONDB_CONNECTION_P_H
#define JSONDB_CONNECTION_P_H

#include <QObject>
#include <QVariantMap>
#include <QSet>
#include <QStringList>
#include <QLocalSocket>
#include <QTcpSocket>
#include <QScopedPointer>

#include "jsondb-global.h"

QT_BEGIN_NAMESPACE_JSONDB

class JsonDbConnectionPrivate;
class Q_ADDON_JSONDB_EXPORT JsonDbConnection : public QObject
{
    Q_OBJECT
    Q_PROPERTY(Status status READ status NOTIFY statusChanged)

public:
    enum Status {
        // maintain the order to match QML Component enum values (just in case)
        Disconnected = 0,
        Null = Disconnected,
        Ready = 1,
        Connecting = 2,
        Error = 3,

        Authenticating = 4
    };

    static JsonDbConnection *instance();

    static QVariantMap makeCreateRequest(const QVariant &, const QString &partitionName = QString());
    static QVariantMap makeUpdateRequest(const QVariant &, const QString &partitionName = QString());
    static QVariantMap makeRemoveRequest(const QVariant &, const QString &partitionName = QString());
    static QVariantMap makeQueryRequest(const QString &, int offset = 0, int limit = -1, const QString &partitionName = QString());
    static QVariantMap makeQueryRequest(const QString &, int offset, int limit,
                                        const QVariantMap &bindings,
                                        const QString &partitionName = QString());
    static QVariantMap makeNotification(const QString &, const QVariantList &, const QString &partitionName = QString());
    static QVariantMap makeChangesSinceRequest(int stateNumber, const QStringList &types = QStringList(), const QString &partitionName = QString());

    JsonDbConnection(QObject *parent = 0);
    ~JsonDbConnection();

    Status status() const;
    QString errorString() const;

    // One-shot functions allow you to avoid constructing a JsonDbClient
    QT_DEPRECATED
    void oneShot( const QVariantMap& dbrequest, QObject *receiver=0,
                  const char *responseSlot=0, const char *errorSlot=0);
    // Synchronized calls pause execution until successful
    QVariant sync(const QVariantMap &dbrequest);

    void connectToServer(const QString &socketName = QString());
    void connectToHost(const QString &hostname, quint16 port);
    void disconnectFromServer();

    // General purpose request
    int  request(const QVariantMap &request);
    bool request(int requestId, const QVariantMap &request);

    bool isConnected() const;
    Q_DECL_DEPRECATED inline bool connected() const
    { return isConnected(); }

    int makeRequestId();

    bool waitForConnected(int msecs = 30000);
    bool waitForDisconnected(int msecs = 30000);
    bool waitForBytesWritten(int msecs = 30000);

signals:
    void notified(const QString &notify_uuid, const QVariant &object, const QString &action);
    void response(int id, const QVariant &data);
    void error(int id, int code, const QString &message);

    void connected();
    void disconnected();

    // signals for properties
    void statusChanged();

private:
    Q_DISABLE_COPY(JsonDbConnection)
    Q_DECLARE_PRIVATE(JsonDbConnection)
    QScopedPointer<JsonDbConnectionPrivate> d_ptr;
    Q_PRIVATE_SLOT(d_func(), void _q_onConnected())
    Q_PRIVATE_SLOT(d_func(), void _q_onDisconnected())
    Q_PRIVATE_SLOT(d_func(), void _q_onError(QLocalSocket::LocalSocketError))
    Q_PRIVATE_SLOT(d_func(), void _q_onReceiveMessage(QJsonObject))
};

QT_END_NAMESPACE_JSONDB

#endif /* JSONDB_CONNECTION_P_H */