summaryrefslogtreecommitdiff
path: root/src/websockets/qwebsocket.cpp
diff options
context:
space:
mode:
authorKurt Pattyn <pattyn.kurt@gmail.com>2014-01-25 14:48:20 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-02-01 15:36:18 +0100
commit595551b06d971fe6a01c08b0779b531d054c47f9 (patch)
tree17f094644586f6102e62cfadddbccb10e9c5c1c9 /src/websockets/qwebsocket.cpp
parent88de191cfbde67fffedad211317afad0ff3cee3c (diff)
downloadqtwebsockets-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/qwebsocket.cpp')
-rw-r--r--src/websockets/qwebsocket.cpp6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index 40b9da1..17bd364 100644
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -53,6 +53,12 @@
This class was modeled after QAbstractSocket.
+ QWebSocket currently does not support
+ \l {http://tools.ietf.org/html/rfc6455#page-39} {extensions} and
+ \l {http://tools.ietf.org/html/rfc6455#page-12} {subprotocols}.
+
+ QWebSocket only supports version 13 of the WebSocket protocol, as outlined in RFC 6455.
+
\sa QAbstractSocket, QTcpSocket
\sa {QWebSocket client example}