aboutsummaryrefslogtreecommitdiffstats
path: root/src/enginio_client/enginiobackendconnection_p.h
blob: 0c8462bbe720399c0b0955606b55030872077c9c (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtEnginio module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef ENGINIOBACKENDCONNECTION_P_H
#define ENGINIOBACKENDCONNECTION_P_H

#include <QtCore/qbasictimer.h>
#include <QtCore/qjsonobject.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qurl.h>
#include <QtNetwork/qabstractsocket.h>

#include <Enginio/enginioclient_global.h>

QT_BEGIN_NAMESPACE

class EnginioClient;
class EnginioClientConnectionPrivate;
class EnginioReply;
class QTcpSocket;

class ENGINIOCLIENT_EXPORT EnginioBackendConnection : public QObject
{
    Q_OBJECT

    enum WebSocketOpcode
    {
        ContinuationFrameOp = 0x0,
        TextFrameOp = 0x1,
        BinaryFrameOp = 0x2,
        // %x3-7 are reserved for further non-control frames
        ConnectionCloseOp = 0x8,
        PingOp = 0x9,
        PongOp = 0xA
        // %xB-F are reserved for further control frames
    } _protocolOpcode;

    enum ProtocolDecodeState
    {
        HandshakePending,
        FrameHeaderPending,
        PayloadDataPending
    } _protocolDecodeState;

    bool _sentCloseFrame;
    bool _isFinalFragment;
    bool _isPayloadMasked;
    quint64 _payloadLength;
    QByteArray _applicationData;

    QUrl _socketUrl;
    QByteArray _handshakeReply;
    QTcpSocket *_tcpSocket;
    QBasicTimer _keepAliveTimer;
    QBasicTimer _pingTimeoutTimer;

public:
    enum WebSocketCloseStatus
    {
        UnknownCloseStatus = -1,
        NormalCloseStatus = 1000,
        GoingAwayCloseStatus = 1001,
        ProtocolErrorCloseStatus = 1002,
        UnsupportedDataTypeCloseStatus = 1003,
        // 1004 Reserved. Not used.
        // 1005 Missing status code. Not used.
        // 1006 Abnormal disconnect. Not used.
        InconsistentDataTypeCloseStatus = 1007,
        PolicyViolationCloseStatus = 1008,
        MessageTooBigCloseStatus = 1009,
        MissingExtensionClientCloseStatus = 1010,
        BadOperationServerCloseStatus = 1011
        // 1015 TLS handshake failed. Not used.
    };

    enum ConnectionState {
        DisconnectedState,
        ConnectingState,
        ConnectedState
    };

    explicit EnginioBackendConnection(QObject *parent = 0);

    bool isConnected() { return _protocolDecodeState > HandshakePending; }
    void connectToBackend(EnginioClientConnectionPrivate *client, const QJsonObject& messageFilter = QJsonObject());
    void connectToBackend(EnginioClient *client, const QJsonObject& messageFilter = QJsonObject());

    void close(WebSocketCloseStatus closeStatus = NormalCloseStatus);
    void ping();

signals:
    void stateChanged(ConnectionState state);
    void dataReceived(QJsonObject data);
    void timeOut();
    void pong();

private slots:
    void onEnginioFinished(EnginioReply *);
    void onSocketStateChanged(QAbstractSocket::SocketState);
    void onSocketConnectionError(QAbstractSocket::SocketError);
    void onSocketReadyRead();

private:
    void timerEvent(QTimerEvent *event);
    void protocolError(const char* message, WebSocketCloseStatus status = ProtocolErrorCloseStatus);
};

QT_END_NAMESPACE

#endif // ENGINIOBACKENDCONNECTION_P_H