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 QWEBSOCKETHANDSHAKERESPONSE_P_H
41#define QWEBSOCKETHANDSHAKERESPONSE_P_H
42//
43// W A R N I N G
44// -------------
45//
46// This file is not part of the Qt API. It exists purely as an
47// implementation detail. This header file may change from version to
48// version without notice, or even be removed.
49//
50// We mean it.
51//
52
53#include <QtCore/QObject>
54#include <QtCore/QList>
55#include "qwebsocketprotocol.h"
56
57QT_BEGIN_NAMESPACE
58
59class QWebSocketHandshakeRequest;
60class QString;
61class QTextStream;
62
63class Q_AUTOTEST_EXPORT QWebSocketHandshakeResponse : public QObject
64{
65 Q_OBJECT
66 Q_DISABLE_COPY(QWebSocketHandshakeResponse)
67
68public:
69 QWebSocketHandshakeResponse(const QWebSocketHandshakeRequest &request,
70 const QString &serverName,
71 bool isOriginAllowed,
72 const QList<QWebSocketProtocol::Version> &supportedVersions,
73 const QList<QString> &supportedProtocols,
74 const QList<QString> &supportedExtensions);
75
76 ~QWebSocketHandshakeResponse() override;
77
78 bool isValid() const;
79 bool canUpgrade() const;
80 QString acceptedProtocol() const;
81 QString acceptedExtension() const;
82 QWebSocketProtocol::Version acceptedVersion() const;
83
84 QWebSocketProtocol::CloseCode error() const;
85 QString errorString() const;
86
87private:
88 bool m_isValid;
89 bool m_canUpgrade;
90 QString m_response;
91 QString m_acceptedProtocol;
92 QString m_acceptedExtension;
93 QWebSocketProtocol::Version m_acceptedVersion;
94 QWebSocketProtocol::CloseCode m_error;
95 QString m_errorString;
96
97 QString calculateAcceptKey(const QString &key) const;
98 QString getHandshakeResponse(const QWebSocketHandshakeRequest &request,
99 const QString &serverName,
100 bool isOriginAllowed,
101 const QList<QWebSocketProtocol::Version> &supportedVersions,
102 const QList<QString> &supportedProtocols,
103 const QList<QString> &supportedExtensions);
104
105 QTextStream &writeToStream(QTextStream &textStream) const;
106 Q_AUTOTEST_EXPORT friend QTextStream & operator <<(QTextStream &stream,
107 const QWebSocketHandshakeResponse &response);
108};
109
110Q_AUTOTEST_EXPORT QTextStream & operator <<(QTextStream &stream,
111 const QWebSocketHandshakeResponse &response);
112
113QT_END_NAMESPACE
114
115#endif // QWEBSOCKETHANDSHAKERESPONSE_P_H
116

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