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:LGPL21$
   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 or version 3 as published by the Free
  20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
  21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
  22 ** following information to ensure the GNU Lesser General Public License
  23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
  24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  25 **
  26 ** In addition, as a special exception, Digia gives you certain additional
  27 ** rights. These rights are described in the Digia Qt LGPL Exception
  28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  29 **
  30 ** $QT_END_LICENSE$
  31 **
  32 ****************************************************************************/
  33
  34 #ifndef QWEBSOCKETPROTOCOL_P_H
  35 #define QWEBSOCKETPROTOCOL_P_H
  36
  37 #include <QtCore/qglobal.h>
  38 #include "QtWebSockets/qwebsocketprotocol.h"
  39
  40 QT_BEGIN_NAMESPACE
  41
  42 class QString;
  43 class QByteArray;
  44
  45 namespace QWebSocketProtocol
  46 {
  47 enum OpCode
  48 {
  49     OpCodeContinue    = 0x0,
  50     OpCodeText        = 0x1,
  51     OpCodeBinary      = 0x2,
  52     OpCodeReserved3   = 0x3,
  53     OpCodeReserved4   = 0x4,
  54     OpCodeReserved5   = 0x5,
  55     OpCodeReserved6   = 0x6,
  56     OpCodeReserved7   = 0x7,
  57     OpCodeClose       = 0x8,
  58     OpCodePing        = 0x9,
  59     OpCodePong        = 0xA,
  60     OpCodeReservedB   = 0xB,
  61     OpCodeReservedC   = 0xC,
  62     OpCodeReservedD   = 0xD,
  63     OpCodeReservedE   = 0xE,
  64     OpCodeReservedF   = 0xF
  65 };
  66
  67 inline bool isOpCodeReserved(OpCode code)
  68 {
  69     return ((code > OpCodeBinary) && (code < OpCodeClose)) || (code > OpCodePong);
  70 }
  71
  72 inline bool isCloseCodeValid(int closeCode)
  73 {
  74     return  (closeCode > 999) && (closeCode < 5000) &&
  75             (closeCode != CloseCodeReserved1004) &&          //see RFC6455 7.4.1
  76             (closeCode != CloseCodeMissingStatusCode) &&
  77             (closeCode != CloseCodeAbnormalDisconnection) &&
  78             ((closeCode >= 3000) || (closeCode < 1012));
  79 }
  80
  81 inline Version currentVersion() { return VersionLatest; }
  82 Version Q_AUTOTEST_EXPORT versionFromString(const QString &versionString);
  83
  84 void Q_AUTOTEST_EXPORT mask(QByteArray *payload, quint32 maskingKey);
  85 void Q_AUTOTEST_EXPORT mask(char *payload, quint64 size, quint32 maskingKey);
  86 }       //end namespace QWebSocketProtocol
  87
  88 QT_END_NAMESPACE
  89
  90 #endif // QWEBSOCKETPROTOCOL_P_H