summaryrefslogtreecommitdiffstats
path: root/src/jsonstream/qjsonconnection.h
blob: 92a3455c6ea65ff2c1df6d1c8cb5b52d7914ab2f (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
142
143
144
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtAddOn.JsonStream module of the Qt.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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 _JSON_CONNECTION_H
#define _JSON_CONNECTION_H

#include "qjsonstream-global.h"
#include <QObject>

QT_BEGIN_NAMESPACE_JSONSTREAM

class QJsonEndpoint;
class QJsonConnectionProcessor;

class QJsonConnectionPrivate;
class Q_ADDON_JSONSTREAM_EXPORT QJsonConnection : public QObject
{
    Q_OBJECT
    Q_PROPERTY(State state READ state)
    Q_PROPERTY(QString localSocketName READ localSocketName WRITE setLocalSocketName)
    Q_PROPERTY(QString tcpHostName READ tcpHostName WRITE setTcpHostName)
    Q_PROPERTY(int tcpHostPort READ tcpHostPort WRITE setTcpHostPort)
    Q_PROPERTY(QString endpointPropertyName READ endpointPropertyName WRITE setEndpointPropertyName)
    Q_PROPERTY(bool autoReconnectEnabled READ autoReconnectEnabled WRITE setAutoReconnectEnabled)
    Q_PROPERTY(bool useSeparateThreadForProcessing READ useSeparateThreadForProcessing WRITE setUseSeparateThreadForProcessing)
    Q_PROPERTY(qint64 readBufferSize READ readBufferSize WRITE setReadBufferSize)
    Q_PROPERTY(qint64 writeBufferSize READ writeBufferSize WRITE setWriteBufferSize)
    Q_PROPERTY(QJsonEndpoint * defaultEndpoint READ defaultEndpoint)
public:
    QJsonConnection(QObject *parent = 0);
    ~QJsonConnection();

    enum State {
        Unconnected = 0,
        Connecting,
        Authenticating,
        Connected
    };
    Q_ENUMS(State)

    State state() const;

    enum Error {
        NoError = 0,
        UnknownError,
        LocalSocketError,
        TcpSocketError
    };
    Q_ENUMS(Error)

    Error error() const;
    int subError() const;
    QString errorString() const;

    QString localSocketName() const;
    void setLocalSocketName(const QString &);

    QString tcpHostName() const;
    void setTcpHostName(const QString &);

    int tcpHostPort() const;
    void setTcpHostPort(int);

    QString endpointPropertyName() const;
    void setEndpointPropertyName(const QString &);

    bool autoReconnectEnabled() const;
    void setAutoReconnectEnabled(bool);

    bool useSeparateThreadForProcessing() const;
    void setUseSeparateThreadForProcessing(bool);

    qint64 readBufferSize() const;
    void setReadBufferSize(qint64);

    qint64 writeBufferSize() const;
    void setWriteBufferSize(qint64 sz);

    Q_INVOKABLE bool connectTCP(const QString& hostname = QString::null, int port = 0);
    Q_INVOKABLE bool connectLocal(const QString& socketname = QString::null);

    void addEndpoint(QJsonEndpoint *);
    QJsonEndpoint * defaultEndpoint();
    void removeEndpoint(QJsonEndpoint *);

    void setFormat( EncodingFormat format );

    QJsonConnectionProcessor *processor() const;

signals:
    void bytesWritten(qint64);
    void readBufferOverflow(qint64);
    void stateChanged(QJsonConnection::State);
    void disconnected();
    void error(QJsonConnection::Error, int);

private slots:
    void handleError(QJsonConnection::Error, int, QString);

private:
    Q_DECLARE_PRIVATE(QJsonConnection)
    QScopedPointer<QJsonConnectionPrivate> d_ptr;

    // forbid copy constructor
    QJsonConnection(const QJsonConnection &);
    void operator=(const QJsonConnection &);
};

QT_END_NAMESPACE_JSONSTREAM

Q_DECLARE_METATYPE(::QtAddOn::QtJsonStream::QJsonConnection::State)
Q_DECLARE_METATYPE(::QtAddOn::QtJsonStream::QJsonConnection::Error)

#endif // _JSON_CONNECTION_H