summaryrefslogtreecommitdiffstats
path: root/src/core/doc/src/qtwebengine-features.qdoc
diff options
context:
space:
mode:
authorSzabolcs David <davidsz@inf.u-szeged.hu>2022-10-18 10:55:43 +0200
committerSzabolcs David <davidsz@inf.u-szeged.hu>2022-11-03 12:30:25 +0100
commitd1607c91dff1d02621c64cc93d3c1a246ce4fe9f (patch)
tree66c3a63edc0fb3ac8b83494d6893d745248e944c /src/core/doc/src/qtwebengine-features.qdoc
parent6149f2899a96b4ce2f0092f881655ca6854f4532 (diff)
Mention WebSockets in docs
QtWebChannel has an example for a use case of HTML web sockets and connectivity of the native side of application. We don't need to create a new example of our own by mentioning this. However, the chat client application uses JS libraries served from remote, so we have to enable LocalContentCanAccessRemoteUrls setting to make it work out of the box in WebEngine example browsers. Desktop Chrome works the same way by default. Task-number: QTBUG-106505 Change-Id: I9020d0a09a88de16d32af063aee5d55c9837f484 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src/core/doc/src/qtwebengine-features.qdoc')
-rw-r--r--src/core/doc/src/qtwebengine-features.qdoc16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/core/doc/src/qtwebengine-features.qdoc b/src/core/doc/src/qtwebengine-features.qdoc
index dc38f5069..3b74a4dd6 100644
--- a/src/core/doc/src/qtwebengine-features.qdoc
+++ b/src/core/doc/src/qtwebengine-features.qdoc
@@ -31,6 +31,7 @@
\li \l{webrtc_feature}{WebRTC}
\li \l{Web Notifications}
\li \l{Favicon Handling}
+ \li \l{HTML5 WebSockets}
\endlist
\section1 Audio and Video Codecs
@@ -619,4 +620,19 @@
to be stored in the database.
\note The icon database is not available for off-the-record profiles.
+
+ \section1 HTML5 WebSockets
+
+ \QWE supports the WebSocket JavaScript API to communicate with WebSocket servers
+ using the \c {ws://} or \c {wss://} protocols. Moreover, integration with Qt WebChannel
+ and Qt WebSockets enables communication between JavaScript and the native side of
+ the application.
+
+ The Qt WebChannel module has a great example for a
+ \l[QtWebChannel]{Qt WebChannel ChatServer Example}{chat server}
+ and its web based
+ \l[QtWebChannel]{Qt WebChannel ChatClient HTML Example}{chat client}.
+ The client works out of the box in the example browsers of \QWE
+ (such as \l{WebEngine Widgets Simple Browser Example}
+ {Simple Browser} or \l{WebEngine Quick Nano Browser}{Nano Browser}).
*/