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 QWEBSOCKETPROTOCOL_P_H
41#define QWEBSOCKETPROTOCOL_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/qglobal.h>
55#include "QtWebSockets/qwebsocketprotocol.h"
56
57QT_BEGIN_NAMESPACE
58
59class QString;
60class QByteArray;
61
62namespace QWebSocketProtocol
63{
64enum OpCode
65{
66 OpCodeContinue = 0x0,
67 OpCodeText = 0x1,
68 OpCodeBinary = 0x2,
69 OpCodeReserved3 = 0x3,
70 OpCodeReserved4 = 0x4,
71 OpCodeReserved5 = 0x5,
72 OpCodeReserved6 = 0x6,
73 OpCodeReserved7 = 0x7,
74 OpCodeClose = 0x8,
75 OpCodePing = 0x9,
76 OpCodePong = 0xA,
77 OpCodeReservedB = 0xB,
78 OpCodeReservedC = 0xC,
79 OpCodeReservedD = 0xD,
80 OpCodeReservedE = 0xE,
81 OpCodeReservedF = 0xF
82};
83
84inline bool isOpCodeReserved(OpCode code)
85{
86 return ((code > OpCodeBinary) && (code < OpCodeClose)) || (code > OpCodePong);
87}
88
89inline bool isCloseCodeValid(int closeCode)
90{
91 return (closeCode > 999) && (closeCode < 5000) &&
92 (closeCode != CloseCodeReserved1004) && //see RFC6455 7.4.1
93 (closeCode != CloseCodeMissingStatusCode) &&
94 (closeCode != CloseCodeAbnormalDisconnection) &&
95 ((closeCode >= 3000) || (closeCode < 1012));
96}
97
98inline Version currentVersion() { return VersionLatest; }
99Version Q_AUTOTEST_EXPORT versionFromString(const QString &versionString);
100
101void Q_AUTOTEST_EXPORT mask(QByteArray *payload, quint32 maskingKey);
102void Q_AUTOTEST_EXPORT mask(char *payload, quint64 size, quint32 maskingKey);
103} //end namespace QWebSocketProtocol
104
105QT_END_NAMESPACE
106
107#endif // QWEBSOCKETPROTOCOL_P_H
108

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