aboutsummaryrefslogtreecommitdiffstats
path: root/src/webchannel/qwebsocketserver_p.h
blob: 4651d172f57d4d1f05b9ce134e7b9768a0f86dce (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Copyright (C) 2013 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
** Contact: http://www.qt-project.org/legal
*
** This file is part of the QtWebChannel 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 QWEBSOCKET_H
#define QWEBSOCKET_H

#include <QObject>
#include <QHostAddress>

class QTcpServer;
class QTcpSocket;

class QWebSocketServer : public QObject
{
    Q_OBJECT

public:
    explicit QWebSocketServer(QObject* parent = 0);
    virtual ~QWebSocketServer();

    bool listen(const QHostAddress& address = QHostAddress::LocalHost, quint16 port = 0);
    void close();

    QHostAddress address() const;
    quint16 port() const;

    QString errorString() const;

signals:
    void opened();
    void error(QAbstractSocket::SocketError);
    void textDataReceived(const QString& data);
    void binaryDataReceived(const QByteArray& data);
    void pongReceived();

public slots:
    void sendMessage(const QByteArray& message) const;
    void ping() const;

private slots:
    void newConnection();
    void readSocketData();
    void disconnected();

protected:
    struct HeaderData
    {
        HeaderData()
        : hasVersion(false)
        , hasUpgrade(false)
        , hasConnection(false)
        , wasUpgraded(false)
        {
        }
        QByteArray path;
        QByteArray host;
        QByteArray origin;
        QByteArray key;
        QByteArray protocol;
        QVector<QByteArray> otherHeaders;
        // no bitmap here - we only have few of these objects
        bool hasVersion;
        bool hasUpgrade;
        bool hasConnection;
        bool wasUpgraded;
    };
    virtual bool isValid(const HeaderData& connection);

private:
    struct Frame
    {
        enum State {
            ReadStart,
            ReadExtendedPayload,
            ReadExtendedLongPayload,
            ReadMask,
            ReadData,
            Finished
        };
        enum Opcode {
            ContinuationFrame = 0x0,
            TextFrame = 0x1,
            BinaryFrame = 0x2,
            ConnectionClose = 0x8,
            Ping = 0x9,
            Pong = 0xA
        };
        // no bitmap here - we only have a few of these objects
        State state;
        Opcode opcode;
        bool fin;
        bool masked;
        ///NOTE: standard says unsigned 64bit integer but QByteArray only supports 'int' size
        int length;
        char mask[4];
        QByteArray data;
        // fragmentation support
        Opcode initialOpcode;
        QByteArray fragments;
    };
    struct Connection
    {
        HeaderData header;
        Frame currentFrame;
    };

    void readHeaderData(QTcpSocket* socket, HeaderData& header);
    void close(QTcpSocket* socket, const HeaderData& header);
    void upgrade(QTcpSocket* socket, HeaderData& header);
    bool readFrameData(QTcpSocket* socket, Frame& frame);
    void handleFrame(QTcpSocket* socket, Frame& frame);

    void sendFrame(Frame::Opcode opcode, const QByteArray& data) const;
    void sendFrame(QTcpSocket* socket, Frame::Opcode opcode, const QByteArray& data) const;
    QByteArray frameHeader(Frame::Opcode opcode, const int dataSize) const;

    QTcpServer* m_server;
    QHash<QTcpSocket*, Connection> m_connections;
};

#endif // QWEBSOCKET_H