summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2014-03-12 15:27:25 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-12 16:03:15 +0100
commit35c81567825c8bfb5c79f867d36a645e1a566a3a (patch)
treefec310293a39f2c0548ff13faacef6d7b50e89ce
parent270fd7f059a85d6a88d30ae3874006a2aff26dbe (diff)
downloadqtdoc-35c81567825c8bfb5c79f867d36a645e1a566a3a.tar.gz
Doc: Added info on Qt WebSockets module
Task-number: QTBUG-79516 Change-Id: If062d217a223de65379188367ffc2c8917e72bb4 Reviewed-by: Martin Smith <martin.smith@digia.com>
-rw-r--r--doc/src/connectivity.qdoc6
-rw-r--r--doc/src/qtmodules.qdoc3
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/src/connectivity.qdoc b/doc/src/connectivity.qdoc
index e3a1ccdd..ea02d583 100644
--- a/doc/src/connectivity.qdoc
+++ b/doc/src/connectivity.qdoc
@@ -91,6 +91,12 @@ online/offline status or whether Wifi or 3G is used).
Qt also offers HTTP support in QML by either using HTTP explicitly via
XmlHttpRequest, or by transparently using HTTP URLs in e.g. Image sources.
+For browser-based applications requiring two-way communication, Qt WebSockets provides
+a communication mode between a client running untrusted code in a controlled environment
+to a remote host that has opted-in to communications from that code.
+The protocol consists of an opening handshake followed by basic message framing,
+layered over TCP.
+
Related Topics:
\list
\li \l{Qt Network} - module documentation
diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc
index 4772ab1f..9bfcde97 100644
--- a/doc/src/qtmodules.qdoc
+++ b/doc/src/qtmodules.qdoc
@@ -97,6 +97,9 @@
\row
\li \l{Qt Widgets}
\li Classes to extend Qt GUI with C++ widgets.
+ \row
+ \li \l{Qt WebSockets}
+ \li A QT implementation of the WebSocket protocol.
\endtable
If you use \l qmake to build your projects, the \l{Qt Core} and \l{Qt GUI}