diff options
| author | Kurt Pattyn <pattyn.kurt@gmail.com> | 2014-01-25 14:48:20 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-02-01 15:36:18 +0100 |
| commit | 595551b06d971fe6a01c08b0779b531d054c47f9 (patch) | |
| tree | 17f094644586f6102e62cfadddbccb10e9c5c1c9 /src/websockets/qwebsocketprotocol.cpp | |
| parent | 88de191cfbde67fffedad211317afad0ff3cee3c (diff) | |
| download | qtwebsockets-595551b06d971fe6a01c08b0779b531d054c47f9.tar.gz | |
Update documentation
Clarified which versions are supported and that subprotocols
and extensions are not supported. Fixed some typos.
Change-Id: I99ef2fbbf74c287bea7d1b7a07881bf0542135ff
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
Diffstat (limited to 'src/websockets/qwebsocketprotocol.cpp')
| -rw-r--r-- | src/websockets/qwebsocketprotocol.cpp | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/websockets/qwebsocketprotocol.cpp b/src/websockets/qwebsocketprotocol.cpp index efcc313..01178ad 100644 --- a/src/websockets/qwebsocketprotocol.cpp +++ b/src/websockets/qwebsocketprotocol.cpp @@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE \value CloseCodeTooMuchData Message too big \value CloseCodeMissingExtension Mandatory extension missing \value CloseCodeBadOperation Internal server error - \value CloseCodeHandshakeFailed TLS handshake failed + \value CloseCodeTlsHandshakeFailed TLS handshake failed \sa QWebSocket::close() */ @@ -85,37 +85,44 @@ QT_BEGIN_NAMESPACE For an overview of the differences between the different protocols, see <http://code.google.com/p/pywebsocket/wiki/WebSocketProtocolSpec> - \value VersionUnknow Unknown or unspecified version. + \value VersionUnknown Unknown or unspecified version. \value Version0 hixie76: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 & hybi-00: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00. Works with key1, key2 and a key in the payload. Attribute: Sec-WebSocket-Draft value 0. + Not supported by QtWebSockets. \value Version4 hybi-04: http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-04.txt. Changed handshake: key1, key2, key3 ==> Sec-WebSocket-Key, Sec-WebSocket-Nonce, Sec-WebSocket-Accept Sec-WebSocket-Draft renamed to Sec-WebSocket-Version Sec-WebSocket-Version = 4. + Not supported by QtWebSockets. \value Version5 hybi-05: http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-05.txt. Sec-WebSocket-Version = 5 Removed Sec-WebSocket-Nonce Added Sec-WebSocket-Accept. + Not supported by QtWebSockets. \value Version6 Sec-WebSocket-Version = 6. + Not supported by QtWebSockets. \value Version7 hybi-07: http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07. Sec-WebSocket-Version = 7. + Not supported by QtWebSockets. \value Version8 hybi-8, hybi-9, hybi-10, hybi-11 and hybi-12. Status codes 1005 and 1006 are added and all codes are now unsigned Internal error results in 1006. + Not supported by QtWebSockets. \value Version13 hybi-13, hybi14, hybi-15, hybi-16, hybi-17 and RFC 6455. Sec-WebSocket-Version = 13 Status code 1004 is now reserved Added 1008, 1009 and 1010 Must support TLS - Clarify multiple version suppor.t + Clarify multiple version support. + Supported by QtWebSockets. \value VersionLatest Refers to the latest known version to QtWebSockets. */ |