src/qwebsocketprotocol.h

   1 /**
   2  * @file websocketprotocol.h
   3  * @brief Contains constants related to the WebSocket standard.
   4  * @author Kurt Pattyn (pattyn.kurt@gmail.com)
   5  */
   6 #ifndef QWEBSOCKETPROTOCOL_H
   7 #define QWEBSOCKETPROTOCOL_H
   8
   9 class QString;
  10 class QByteArray;
  11 #include <qglobal.h>
  12
  13 namespace QWebSocketProtocol
  14 {
  15         enum Version
  16         {
  17                 V_Unknow = -1,
  18                 V_0 = 0,
  19                 //hybi-01, hybi-02 and hybi-03 not supported
  20                 V_4 = 4,
  21                 V_5 = 5,
  22                 V_6 = 6,
  23                 V_7 = 7,
  24                 V_8 = 8,
  25                 V_13 = 13,
  26                 V_LATEST = V_13
  27         };
  28
  29         Version versionFromString(const QString &versionString);
  30
  31         enum CloseCode
  32         {
  33                 CC_NORMAL                                       = 1000,
  34                 CC_GOING_AWAY                           = 1001,
  35                 CC_PROTOCOL_ERROR                       = 1002,
  36                 CC_DATATYPE_NOT_SUPPORTED       = 1003,
  37                 CC_RESERVED_1004                        = 1004,
  38                 CC_MISSING_STATUS_CODE          = 1005,
  39                 CC_ABNORMAL_DISCONNECTION       = 1006,
  40                 CC_WRONG_DATATYPE                       = 1007,
  41                 CC_POLICY_VIOLATED                      = 1008,
  42                 CC_TOO_MUCH_DATA                        = 1009,
  43                 CC_MISSING_EXTENSION            = 1010,
  44                 CC_BAD_OPERATION                        = 1011,
  45                 CC_TLS_HANDSHAKE_FAILED         = 1015
  46         };
  47
  48         enum OpCode
  49         {
  50                 OC_CONTINUE             = 0x0,
  51                 OC_TEXT                 = 0x1,
  52                 OC_BINARY               = 0x2,
  53                 OC_RESERVED_3   = 0x3,
  54                 OC_RESERVED_4   = 0x4,
  55                 OC_RESERVED_5   = 0x5,
  56                 OC_RESERVED_6   = 0x6,
  57                 OC_RESERVED_7   = 0x7,
  58                 OC_CLOSE                = 0x8,
  59                 OC_PING                 = 0x9,
  60                 OC_PONG                 = 0xA,
  61                 OC_RESERVED_B   = 0xB,
  62                 OC_RESERVED_V   = 0xC,
  63                 OC_RESERVED_D   = 0xD,
  64                 OC_RESERVED_E   = 0xE,
  65                 OC_RESERVED_F   = 0xF
  66         };
  67
  68
  69         inline bool isOpCodeReserved(OpCode code)
  70         {
  71                 return ((code > OC_BINARY) && (code < OC_CLOSE)) || (code > OC_PONG);
  72         }
  73         inline bool isCloseCodeValid(int closeCode)
  74         {
  75                 return  (closeCode > 999) && (closeCode < 5000) &&
  76                                 (closeCode != CC_RESERVED_1004) &&          //see RFC6455 7.4.1
  77                                 (closeCode != CC_MISSING_STATUS_CODE) &&
  78                                 (closeCode != CC_ABNORMAL_DISCONNECTION) &&
  79                                 ((closeCode >= 3000) || (closeCode < 1012));
  80         }
  81
  82         void mask(QByteArray *payload, quint32 maskingKey);
  83         void mask(char *payload, quint64 size, quint32 maskingKey);
  84
  85         inline Version currentVersion() { return V_LATEST; }
  86
  87 }       //end namespace QWebSocketProtocol
  88
  89 #endif // QWEBSOCKETPROTOCOL_H