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