/usr/share/qt5/doc/qtwebsockets/echoserver.html is in qtwebsockets5-doc-html 5.5.1-4build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwebsocketserver.cpp -->
<title>WebSocket server example | Qt WebSockets 5.5</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.5</li>
<li><a href="qtwebsockets-index.html">Qt WebSockets</a></li>
<li>WebSocket server example</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#description">Description</a></li>
<li class="level1"><a href="#code">Code</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">WebSocket server example</h1>
<span class="subtitle"></span>
<!-- $$$echoserver.html-description -->
<div class="descr"> <a name="details"></a>
<a name="description"></a>
<h2 id="description">Description</h2>
<p>The echoserver example implements a <a href="qml-qtwebsockets-websocket.html">WebSocket</a> server that echoes back everything that is sent to it.</p>
<a name="code"></a>
<h2 id="code">Code</h2>
<p>We start by creating a <a href="qwebsocketserver.html">QWebSocketServer</a> (`new QWebSocketServer()`). After the creation, we listen on all local network interfaces (`<a href="../qtnetwork/qhostaddress.html#SpecialAddress-enum">QHostAddress::Any</a>`) on the specified <i>port</i>.</p>
<pre class="cpp">EchoServer<span class="operator">::</span>EchoServer(<span class="type"><a href="../qtcore/qtglobal.html#quint16-typedef">quint16</a></span> port<span class="operator">,</span> bool debug<span class="operator">,</span> <span class="type"><a href="../qtcore/qobject.html">QObject</a></span> <span class="operator">*</span>parent) :
<span class="type"><a href="../qtcore/qobject.html">QObject</a></span>(parent)<span class="operator">,</span>
m_pWebSocketServer(<span class="keyword">new</span> <span class="type"><a href="qwebsocketserver.html">QWebSocketServer</a></span>(<span class="type"><a href="../qtcore/qstring.html#QStringLiteral">QStringLiteral</a></span>(<span class="string">"Echo Server"</span>)<span class="operator">,</span>
<span class="type"><a href="qwebsocketserver.html">QWebSocketServer</a></span><span class="operator">::</span>NonSecureMode<span class="operator">,</span> <span class="keyword">this</span>))<span class="operator">,</span>
m_clients()<span class="operator">,</span>
m_debug(debug)
{
<span class="keyword">if</span> (m_pWebSocketServer<span class="operator">-</span><span class="operator">></span>listen(<span class="type"><a href="../qtnetwork/qhostaddress.html">QHostAddress</a></span><span class="operator">::</span>Any<span class="operator">,</span> port)) {
<span class="keyword">if</span> (m_debug)
<a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Echoserver listening on port"</span> <span class="operator"><</span><span class="operator"><</span> port;
connect(m_pWebSocketServer<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qwebsocketserver.html">QWebSocketServer</a></span><span class="operator">::</span>newConnection<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>EchoServer<span class="operator">::</span>onNewConnection);
connect(m_pWebSocketServer<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qwebsocketserver.html">QWebSocketServer</a></span><span class="operator">::</span>closed<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>EchoServer<span class="operator">::</span>closed);
}
}</pre>
<p>If listening is successful, we connect the `newConnection()` signal to the slot `onNewConnection()`. The `newConnection()` signal will be thrown whenever a new <a href="qml-qtwebsockets-websocket.html">WebSocket</a> client is connected to our server.</p>
<pre class="cpp"><span class="type">void</span> EchoServer<span class="operator">::</span>onNewConnection()
{
<span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span>pSocket <span class="operator">=</span> m_pWebSocketServer<span class="operator">-</span><span class="operator">></span>nextPendingConnection();
connect(pSocket<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span><span class="operator">::</span>textMessageReceived<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>EchoServer<span class="operator">::</span>processTextMessage);
connect(pSocket<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span><span class="operator">::</span>binaryMessageReceived<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>EchoServer<span class="operator">::</span>processBinaryMessage);
connect(pSocket<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span><span class="operator">::</span>disconnected<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>EchoServer<span class="operator">::</span>socketDisconnected);
m_clients <span class="operator"><</span><span class="operator"><</span> pSocket;
}</pre>
<p>When a new connection is received, the client <a href="qwebsocket.html">QWebSocket</a> 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).</p>
<pre class="cpp"><span class="type">void</span> EchoServer<span class="operator">::</span>processTextMessage(<span class="type"><a href="../qtcore/qstring.html">QString</a></span> message)
{
<span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span>pClient <span class="operator">=</span> qobject_cast<span class="operator"><</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span><span class="operator">></span>(sender());
<span class="keyword">if</span> (m_debug)
<a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Message received:"</span> <span class="operator"><</span><span class="operator"><</span> message;
<span class="keyword">if</span> (pClient) {
pClient<span class="operator">-</span><span class="operator">></span>sendTextMessage(message);
}
}</pre>
<p>Whenever `processTextMessage()` is triggered, we retrieve the sender, and if valid, send back the original message (`sendTextMessage()`). The same is done with binary messages.</p>
<pre class="cpp"><span class="type">void</span> EchoServer<span class="operator">::</span>processBinaryMessage(<span class="type"><a href="../qtcore/qbytearray.html">QByteArray</a></span> message)
{
<span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span>pClient <span class="operator">=</span> qobject_cast<span class="operator"><</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span><span class="operator">></span>(sender());
<span class="keyword">if</span> (m_debug)
<a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"Binary Message received:"</span> <span class="operator"><</span><span class="operator"><</span> message;
<span class="keyword">if</span> (pClient) {
pClient<span class="operator">-</span><span class="operator">></span>sendBinaryMessage(message);
}
}</pre>
<p>The only difference is that the message now is a <a href="../qtcore/qbytearray.html">QByteArray</a> instead of a <a href="../qtcore/qstring.html">QString</a>.</p>
<pre class="cpp"><span class="type">void</span> EchoServer<span class="operator">::</span>socketDisconnected()
{
<span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span>pClient <span class="operator">=</span> qobject_cast<span class="operator"><</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span> <span class="operator">*</span><span class="operator">></span>(sender());
<span class="keyword">if</span> (m_debug)
<a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator"><</span><span class="operator"><</span> <span class="string">"socketDisconnected:"</span> <span class="operator"><</span><span class="operator"><</span> pClient;
<span class="keyword">if</span> (pClient) {
m_clients<span class="operator">.</span>removeAll(pClient);
pClient<span class="operator">-</span><span class="operator">></span>deleteLater();
}
}</pre>
<p>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.</p>
</div>
<!-- @@@echoserver.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|