diff options
author | Liang Qi <liang.qi@qt.io> | 2016-06-16 07:10:09 +0200 |
---|---|---|
committer | Liang Qi <liang.qi@qt.io> | 2016-06-16 07:10:09 +0200 |
commit | b84f22a3249aa1af46b17e33ac030abb077251bf (patch) | |
tree | 315d6c8151598a3a3bbad6d4a4161d08bb51a689 /examples/webchannel/chatserver-cpp/doc | |
parent | 4fda82b66e17cc03e6b08f1afd135069cfef09b7 (diff) | |
parent | 23cd16ad672a3d07da00d14276a63901d8d9f118 (diff) | |
download | qtwebchannel-b84f22a3249aa1af46b17e33ac030abb077251bf.tar.gz |
Merge remote-tracking branch 'origin/5.7.0' into 5.7
Change-Id: If663d043ad0da98731e436309d3b40e3379b0831
Diffstat (limited to 'examples/webchannel/chatserver-cpp/doc')
-rw-r--r-- | examples/webchannel/chatserver-cpp/doc/images/chatserver-cpp.png | bin | 0 -> 6829 bytes | |||
-rw-r--r-- | examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc | 32 |
2 files changed, 20 insertions, 12 deletions
diff --git a/examples/webchannel/chatserver-cpp/doc/images/chatserver-cpp.png b/examples/webchannel/chatserver-cpp/doc/images/chatserver-cpp.png Binary files differnew file mode 100644 index 0000000..b0f484a --- /dev/null +++ b/examples/webchannel/chatserver-cpp/doc/images/chatserver-cpp.png diff --git a/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc b/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc index 06d5b2e..0b198d2 100644 --- a/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc +++ b/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc @@ -50,31 +50,39 @@ /*! \example chatserver-cpp - \title Qt WebChannel Chatserver Example + \title Qt WebChannel ChatServer Example \ingroup qtwebchannel-examples - \brief Shows how to use the QWebChannel C++ API to implement a simple chat server + \brief A simple chat server implemented using the QWebChannel C++ API. - The chatserver examples provides a chat service that client examples can connect to. + \image chatserver-cpp.png - \section1 Overview + \e{ChatServer} provides a chat service that the + \l{Qt WebChannel ChatClient QML Example} and + \l{Qt WebChannel ChatClient HTML Example} can connect to. + + \include examples-run.qdocinc + + \section1 Implementing a Chat Server The C++ application implements a QObject which provides all mechanisms required for a chat service. - This object is published through a QWebChannel which uses a WebSocket as transport. + This object is published through a QWebChannel which uses a \l{Qt WebSockets} + {WebSocket} as transport. The server provides a basic \c login method (username only, no passwords), which must be successfully invoked before a client is able to chat. - After login a client can invoke the method \c sendMessage and receive the signal \c newMessage - to write and receive messages. Furthermore there is a \c userList property which provides + After login, a client can invoke the method \c sendMessage and receive the signal \c newMessage + to write and receive messages. Furthermore, there is a \c userList property which provides the names of all other connected clients. - Additionally the server sends a keepAlive signal periodically to all clients. The clients + Additionally the server sends a \c keepAlive signal periodically to all clients. The clients have to respond to this signal, otherwise the client will be removed from the \c userList property. - The example shows how basic QObject elements can be used with QWebChannel, i.e. signals - (\c newMessage), slots (\c sendMessage) and properties (\c userList). + The example shows how basic QObject elements can be used with QWebChannel, that is signals + (\c newMessage), slots (\c sendMessage), and properties (\c userList). - Because this is a plain server application, there are separated clients needed to interact - with the server. Both examples chatclient-qml and chatclient-html show a client implementation + Because this is a plain server application, separate clients are needed to + interact with it. \l{Qt WebChannel ChatClient QML Example} and + \l{Qt WebChannel ChatClient HTML Example} are client implementations compatible with this server. */ |