1/****************************************************************************
2**
3** Copyright (C) 2016 Kurt Pattyn <pattyn.kurt@gmail.com>.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWebSockets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QWEBSOCKETFRAME_P_H
41#define QWEBSOCKETFRAME_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/QString>
55#include <QtCore/QByteArray>
56#include <QtCore/QCoreApplication>
57#include <limits>
58
59#include "qwebsockets_global.h"
60#include "qwebsocketprotocol.h"
61#include "qwebsocketprotocol_p.h"
62
63QT_BEGIN_NAMESPACE
64
65class QIODevice;
66
67const quint64 MAX_FRAME_SIZE_IN_BYTES = std::numeric_limits<int>::max() - 1;
68
69class Q_AUTOTEST_EXPORT QWebSocketFrame
70{
71 Q_DECLARE_TR_FUNCTIONS(QWebSocketFrame)
72
73public:
74 QWebSocketFrame() = default;
75
76 void setMaxAllowedFrameSize(quint64 maxAllowedFrameSize);
77 quint64 maxAllowedFrameSize() const;
78 static quint64 maxFrameSize();
79
80 QWebSocketProtocol::CloseCode closeCode() const;
81 QString closeReason() const;
82 bool isFinalFrame() const;
83 bool isControlFrame() const;
84 bool isDataFrame() const;
85 bool isContinuationFrame() const;
86 bool hasMask() const;
87 quint32 mask() const; //returns 0 if no mask
88 inline bool rsv1() const { return m_rsv1; }
89 inline bool rsv2() const { return m_rsv2; }
90 inline bool rsv3() const { return m_rsv3; }
91 QWebSocketProtocol::OpCode opCode() const;
92 QByteArray payload() const;
93
94 void clear();
95
96 bool isValid() const;
97 bool isDone() const;
98
99 void readFrame(QIODevice *pIoDevice);
100
101private:
102 QString m_closeReason;
103 QByteArray m_payload;
104 quint64 m_length = 0;
105 quint32 m_mask = 0;
106 QWebSocketProtocol::CloseCode m_closeCode = QWebSocketProtocol::CloseCodeNormal;
107 QWebSocketProtocol::OpCode m_opCode = QWebSocketProtocol::OpCodeReservedC;
108
109 enum ProcessingState
110 {
111 PS_READ_HEADER,
112 PS_READ_PAYLOAD_LENGTH,
113 PS_READ_MASK,
114 PS_READ_PAYLOAD,
115 PS_DISPATCH_RESULT,
116 PS_WAIT_FOR_MORE_DATA
117 } m_processingState = PS_READ_HEADER;
118
119 bool m_isFinalFrame = true;
120 bool m_rsv1 = false;
121 bool m_rsv2 = false;
122 bool m_rsv3 = false;
123 bool m_isValid = false;
124 quint64 m_maxAllowedFrameSize = MAX_FRAME_SIZE_IN_BYTES;
125
126 ProcessingState readFrameHeader(QIODevice *pIoDevice);
127 ProcessingState readFramePayloadLength(QIODevice *pIoDevice);
128 ProcessingState readFrameMask(QIODevice *pIoDevice);
129 ProcessingState readFramePayload(QIODevice *pIoDevice);
130
131 void setError(QWebSocketProtocol::CloseCode code, const QString &closeReason);
132 bool checkValidity();
133};
134
135QT_END_NAMESPACE
136
137#endif // QWEBSOCKETFRAME_P_H
138

source code of qtwebsockets/src/websockets/qwebsocketframe_p.h