summaryrefslogtreecommitdiff
path: root/src/websockets/qwebsocketserver.cpp
diff options
context:
space:
mode:
authorKurt Pattyn <pattyn.kurt@gmail.com>2013-11-01 17:35:16 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-11-01 17:46:31 +0100
commit4208e524cd0f9dab7d5047a4032e8a3e857d0795 (patch)
treed62d09ab44b18d5a89bf2ad0afcbf1e770c7469d /src/websockets/qwebsocketserver.cpp
parent1fbe1dc4857836dbb38649c435760ae141d79206 (diff)
downloadqtwebsockets-4208e524cd0f9dab7d5047a4032e8a3e857d0795.tar.gz
Refine doc generation
Change-Id: I9da90086c63b88a5664f241da2fa9687c3882ddf Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/qwebsocketserver.cpp')
-rw-r--r--src/websockets/qwebsocketserver.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/websockets/qwebsocketserver.cpp b/src/websockets/qwebsocketserver.cpp
index f267001..048e5da 100644
--- a/src/websockets/qwebsocketserver.cpp
+++ b/src/websockets/qwebsocketserver.cpp
@@ -52,22 +52,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
The echoserver example implements a web socket server that echoes back everything that is sent to it.
\section1 Code
We start by creating a QWebSocketServer (`new QWebSocketServer()`). After the creation, we listen on all local network interfaces (`QHostAddress::Any`) on the specified \a port.
- \snippet echoserver.cpp constructor
+ \snippet echoserver/echoserver.cpp constructor
If listening is successful, we connect the `newConnection()` signal to the slot `onNewConnection()`.
The `newConnection()` signal will be thrown whenever a new web socket client is connected to our server.
- \snippet echoserver.cpp onNewConnection
+ \snippet echoserver/echoserver.cpp onNewConnection
When a new connection is received, the client QWebSocket is retrieved (`nextPendingConnection()`), and the signals we are interested in
are connected to our slots (`textMessageReceived()`, `binaryMessageReceived()` and `disconnected()`).
The client socket is remembered in a list, in case we would like to use it later (in this example, nothing is done with it).
- \snippet echoserver.cpp processMessage
+ \snippet echoserver/echoserver.cpp processMessage
Whenever `processMessage()` is triggered, we retrieve the sender, and if valid, send back the original message (`send()`).
The same is done with binary messages.
- \snippet echoserver.cpp processBinaryMessage
+ \snippet echoserver/echoserver.cpp processBinaryMessage
The only difference is that the message now is a QByteArray instead of a QString.
- \snippet echoserver.cpp socketDisconnected
+ \snippet echoserver/echoserver.cpp socketDisconnected
Whenever a socket is disconnected, we remove it from the clients list and delete the socket.
Note: it is best to use `deleteLater()` to delete the socket.
*/