src/websockets/qwebsockethandshakeresponse_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QWEBSOCKETHANDSHAKERESPONSE_P_H
  43 #define QWEBSOCKETHANDSHAKERESPONSE_P_H
  44 //
  45 //  W A R N I N G
  46 //  -------------
  47 //
  48 // This file is not part of the Qt API.  It exists purely as an
  49 // implementation detail.  This header file may change from version to
  50 // version without notice, or even be removed.
  51 //
  52 // We mean it.
  53 //
  54
  55 #include <QtCore/QObject>
  56 #include <QtCore/QList>
  57 #include "qwebsocketprotocol.h"
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 class QWebSocketHandshakeRequest;
  62 class QString;
  63 class QTextStream;
  64
  65 class Q_AUTOTEST_EXPORT QWebSocketHandshakeResponse : public QObject
  66 {
  67     Q_OBJECT
  68     Q_DISABLE_COPY(QWebSocketHandshakeResponse)
  69
  70 public:
  71     QWebSocketHandshakeResponse(const QWebSocketHandshakeRequest &request,
  72                       const QString &serverName,
  73                       bool isOriginAllowed,
  74                       const QList<QWebSocketProtocol::Version> &supportedVersions,
  75                       const QList<QString> &supportedProtocols,
  76                       const QList<QString> &supportedExtensions);
  77
  78     virtual ~QWebSocketHandshakeResponse();
  79
  80     bool isValid() const;
  81     bool canUpgrade() const;
  82     QString acceptedProtocol() const;
  83     QString acceptedExtension() const;
  84     QWebSocketProtocol::Version acceptedVersion() const;
  85
  86     QWebSocketProtocol::CloseCode error() const;
  87     QString errorString() const;
  88
  89 private:
  90     bool m_isValid;
  91     bool m_canUpgrade;
  92     QString m_response;
  93     QString m_acceptedProtocol;
  94     QString m_acceptedExtension;
  95     QWebSocketProtocol::Version m_acceptedVersion;
  96     QWebSocketProtocol::CloseCode m_error;
  97     QString m_errorString;
  98
  99     QString calculateAcceptKey(const QString &key) const;
 100     QString getHandshakeResponse(const QWebSocketHandshakeRequest &request,
 101                                  const QString &serverName,
 102                                  bool isOriginAllowed,
 103                                  const QList<QWebSocketProtocol::Version> &supportedVersions,
 104                                  const QList<QString> &supportedProtocols,
 105                                  const QList<QString> &supportedExtensions);
 106
 107     QTextStream &writeToStream(QTextStream &textStream) const;
 108     Q_AUTOTEST_EXPORT friend QTextStream & operator <<(QTextStream &stream,
 109                                                        const QWebSocketHandshakeResponse &response);
 110 };
 111
 112 Q_AUTOTEST_EXPORT QTextStream & operator <<(QTextStream &stream,
 113                                             const QWebSocketHandshakeResponse &response);
 114
 115 QT_END_NAMESPACE
 116
 117 #endif // QWEBSOCKETHANDSHAKERESPONSE_P_H