src/websockets/qwebsocketprotocol.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
   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_H
  43 #define QWEBSOCKETPROTOCOL_H
  44
  45 #include <QtCore/qglobal.h>
  46 #include "qwebsockets_global.h"
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 class QString;
  51
  52 namespace QWebSocketProtocol
  53 {
  54 enum Version
  55 {
  56     V_Unknow = -1,
  57     V_0 = 0,
  58     //hybi-01, hybi-02 and hybi-03 not supported
  59     V_4 = 4,
  60     V_5 = 5,
  61     V_6 = 6,
  62     V_7 = 7,
  63     V_8 = 8,
  64     V_13 = 13,
  65     V_LATEST = V_13
  66 };
  67
  68 Version versionFromString(const QString &versionString);
  69
  70 enum CloseCode
  71 {
  72     CC_NORMAL                                   = 1000,
  73     CC_GOING_AWAY                               = 1001,
  74     CC_PROTOCOL_ERROR                   = 1002,
  75     CC_DATATYPE_NOT_SUPPORTED   = 1003,
  76     CC_RESERVED_1004                    = 1004,
  77     CC_MISSING_STATUS_CODE              = 1005,
  78     CC_ABNORMAL_DISCONNECTION   = 1006,
  79     CC_WRONG_DATATYPE                   = 1007,
  80     CC_POLICY_VIOLATED                  = 1008,
  81     CC_TOO_MUCH_DATA                    = 1009,
  82     CC_MISSING_EXTENSION                = 1010,
  83     CC_BAD_OPERATION                    = 1011,
  84     CC_TLS_HANDSHAKE_FAILED             = 1015
  85 };
  86
  87 enum OpCode
  88 {
  89     OC_CONTINUE         = 0x0,
  90     OC_TEXT                     = 0x1,
  91     OC_BINARY           = 0x2,
  92     OC_RESERVED_3       = 0x3,
  93     OC_RESERVED_4       = 0x4,
  94     OC_RESERVED_5       = 0x5,
  95     OC_RESERVED_6       = 0x6,
  96     OC_RESERVED_7       = 0x7,
  97     OC_CLOSE            = 0x8,
  98     OC_PING                     = 0x9,
  99     OC_PONG                     = 0xA,
 100     OC_RESERVED_B       = 0xB,
 101     OC_RESERVED_C       = 0xC,
 102     OC_RESERVED_D       = 0xD,
 103     OC_RESERVED_E       = 0xE,
 104     OC_RESERVED_F       = 0xF
 105 };
 106
 107 inline Version currentVersion() { return V_LATEST; }
 108
 109 }       //end namespace QWebSocketProtocol
 110
 111 QT_END_NAMESPACE
 112
 113 #endif // QWEBSOCKETPROTOCOL_H