diff options
author | Edward Welbourne <edward.welbourne@qt.io> | 2016-07-20 16:27:47 +0200 |
---|---|---|
committer | Edward Welbourne <edward.welbourne@qt.io> | 2016-07-21 16:44:49 +0200 |
commit | 91ebebdbf26907c126dcc367832ed524d64b94cf (patch) | |
tree | d9d4fee39a1fa88a2eb8ff90bcde6ec248550311 /examples/webchannel/standalone/doc/src/standalone.qdoc | |
parent | fa2374d7c4dedea907e2df26fdad28bdee73b122 (diff) | |
parent | 3836fd7d12777fc53836a72d6542d2fbf2f20ac9 (diff) | |
download | qtwebchannel-91ebebdbf26907c126dcc367832ed524d64b94cf.tar.gz |
Merge remote-tracking branch 'origin/5.7' into dev
Conflicts:
src/webchannel/doc/src/index.qdoc
src/webchannel/qwebchannelabstracttransport.cpp
Overlapping changes to documentation; constructed hybrid.
src/webchannel/qmetaobjectpublisher.cpp
tests/auto/webchannel/tst_webchannel.cpp
tests/auto/webchannel/tst_webchannel.h
Both sides made additions; in the same place.
Change-Id: Iff12970978b70946dc3e1290841aca2d35c9c1d0
Diffstat (limited to 'examples/webchannel/standalone/doc/src/standalone.qdoc')
-rw-r--r-- | examples/webchannel/standalone/doc/src/standalone.qdoc | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/examples/webchannel/standalone/doc/src/standalone.qdoc b/examples/webchannel/standalone/doc/src/standalone.qdoc index 28c67a2..0d030bf 100644 --- a/examples/webchannel/standalone/doc/src/standalone.qdoc +++ b/examples/webchannel/standalone/doc/src/standalone.qdoc @@ -53,26 +53,28 @@ \title Qt WebChannel Standalone Example \ingroup qtwebchannel-examples \image standalone-screenshot.png - \brief Shows how to use the QWebChannel C++ API to communicate with an external client. + \brief A simple chat between a server and a remote client running in a + browser. - The standalone example is a simple chat between a C++ application and a remote HTML - client running in your default browser. + \e{Standalone} demonstrates how to use the QWebChannel C++ API to + communicate with an external client. It is a simple chat between a C++ + application and a remote HTML client running in your default browser. \include examples-run.qdocinc - \section1 Overview + \section1 Communicating with a Remote Client - The C++ application sets up a QWebChannel instance and publishes a Dialog object over it. + The C++ application sets up a QWebChannel instance and publishes a \c Dialog object over it. For the remote client side, \l {standalone/index.html}{index.html} is opened. Both show a dialog with the list of received messages and an input box to send messages to the other end. - The Dialog emits the Dialog::sendText() signal when the user sends a message. The signal + The \c Dialog emits the \c Dialog::sendText() signal when the user sends a message. The signal automatically gets propagated to the HTML client. When the user enters a message on the HTML - side, Dialog::receiveText() is called. + side, \c Dialog::receiveText() is called. All communication between the HTML client and the C++ server is done over a WebSocket. The C++ side instantiates a QWebSocketServer and wraps incoming QWebSocket connections - in WebSocketTransport objects, which implement QWebChannelAbstractTransport. These objects are + in QWebChannelAbstractTransport objects. These objects are then connected to the QWebChannel instance. \sa {Qt WebChannel JavaScript API} |