summaryrefslogtreecommitdiff
path: root/src/websockets/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'src/websockets/doc/src')
-rw-r--r--src/websockets/doc/src/external-resources.qdoc126
-rw-r--r--src/websockets/doc/src/index.qdoc8
-rw-r--r--src/websockets/doc/src/overview.qdoc21
3 files changed, 140 insertions, 15 deletions
diff --git a/src/websockets/doc/src/external-resources.qdoc b/src/websockets/doc/src/external-resources.qdoc
new file mode 100644
index 0000000..933ef7f
--- /dev/null
+++ b/src/websockets/doc/src/external-resources.qdoc
@@ -0,0 +1,126 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \externalpage http://w2spconf.com/2011/papers/websocket.pdf
+ \title "Talking to Yourself for Fun and Profit" by Lin-Shung Huang et al
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/rfc6454
+ \title RFC 6454
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/rfc6455
+ \title RFC 6455
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/rfc6455#section-10
+ \title WebSocket Security Considerations
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/rfc6455#page-39
+ \title WebSocket Extensions
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/rfc6455#page-12
+ \title WebSocket Subprotocols
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76
+ \title hixie76
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00
+ \title hybi-00
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-04.txt
+ \title hybi-04
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/id/draft-ietf-hybi-thewebsocketprotocol-05.txt
+ \title hybi-05
+*/
+
+/*!
+ \externalpage http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07
+ \title hybi-07
+*/
+
+/*!
+ \externalpage https://github.com/google/pywebsocket/wiki/WebSocketProtocolSpec
+ \title pywebsocket's WebSocketProtocolSpec
+*/
+
+/*!
+ \externalpage http://autobahn.ws/testsuite/
+ \title Autobahn|Testsuite
+*/
+
+/*!
+ \externalpage http://autobahn.ws/testsuite/installation.html
+ \title Autobahn|Testsuite installation documentation
+*/
+
+/*!
+ \externalpage https://www.mozilla.org/firefox
+ \title Firefox
+*/
+
+/*!
+ \externalpage https://bugzilla.mozilla.org/show_bug.cgi?id=594502
+ \title Firefox bug 594502
+
+/*
+ This prevents autolinking of each occurrence of 'WebSocket'
+ To link to the WebSocket QML type, use explicit linking:
+ \l [QML] WebSocket
+ \sa {QtWebSockets::}{WebSocket}
+*/
+/*!
+ \externalpage nolink
+ \title WebSocket
+ \internal
+*/
+
+/*
+ Prevent linking to WebSockets section in "Networking and Connectivity"
+*/
+/*!
+ \externalpage nolink
+ \title WebSockets
+ \internal
+*/
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index e0f219c..9e1c40c 100644
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -77,10 +77,10 @@
\page qtwebsockets-testing.html
\title Testing Qt WebSockets
- \l {http://autobahn.ws/testsuite/}{Autobahn|Testsuite}, a standard test
- suite for WebSocket Protocol (RFC 6455), can be used for testing the
- conformance of Qt WebSockets. Refer to Autobahn|Testsuite
- \l {http://autobahn.ws/testsuite/installation.html}{installation documentation}
+ \l {Autobahn|Testsuite}, a standard test
+ suite for WebSocket Protocol (\l{RFC 6455}), can be used for testing the
+ conformance of Qt WebSockets. Refer to
+ \l {Autobahn|Testsuite installation documentation}
to set up the test suite.
\include README testsuite
diff --git a/src/websockets/doc/src/overview.qdoc b/src/websockets/doc/src/overview.qdoc
index df080c1..eb9e429 100644
--- a/src/websockets/doc/src/overview.qdoc
+++ b/src/websockets/doc/src/overview.qdoc
@@ -90,23 +90,22 @@ for push notification when there is a change in price of a few stocks.
The module provides both C++ and QML versions of the API, so you can choose
the alternative that suits your need.
-\section2 Qt WebSockets with Qt Cloud Services
+\section2 Qt WebSockets with Cloud Services
The client application usually depends on an external service for data. Most of
these service providers do not support WebSocket yet, so you end up developing
-a WebSocket-aware server application to bridge the gap. You can choose to run
-the server on an enterprise WebSocket gateway service such as Qt Cloud
-Services, avoiding the hassle of maintaining the necessary infrastructure
-required to host such a service.
+a WebSocket-aware server application to bridge the gap. You can run the server
+on an enterprise WebSocket gateway service such as a cloud service, avoiding
+the hassle of maintaining the necessary infrastructure required to host such
+a service.
-The Qt Cloud Services provides a Managed Application Runtime (MAR) backend,
-which enables deploying and running an instance of server application on the
-cloud. The server instance running on MAR gets a WebSocket URL, which can be
-used by the client applications to connect and receive data.
+Most of the cloud Services provide a Platform as a service (PaaS) backend,
+which enables deploying and running an instance of your server application on
+the cloud. The client applications can connect to the running server using a
+WebSocket URL and receive data.
\section2 Related Information
\list
-\li \l {http://tools.ietf.org/html/rfc6455}{WebSocket RFC 6455}
-\li \l {https://qtcloudservices.com}{Qt Cloud Services}
+\li \l{RFC 6455}
\endlist
*/