This file is indexed.

/usr/share/qt5/doc/qtwebsockets/echoclient.html is in qtwebsockets5-doc-html 5.9.5-0ubuntu1.

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwebsocket.cpp -->
  <title>QWebSocket client example | Qt WebSockets 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtwebsockets-index.html">Qt WebSockets</a></td><td >QWebSocket client example</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
        </tr></table>
      </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">QWebSocket client example</h1>
<span class="subtitle"></span>
<!-- $$$echoclient.html-description -->
<div class="descr"> <a name="details"></a>
<a name="description"></a>
<h2 id="description">Description</h2>
<p>The EchoClient example implements a WebSocket client that sends a message to a WebSocket server and dumps the answer that it gets back. This example should ideally be used with the EchoServer example.</p>
<a name="code"></a>
<h2 id="code">Code</h2>
<p>We start by connecting to the `connected()` signal.</p>
<pre class="cpp">

  EchoClient<span class="operator">::</span>EchoClient(<span class="keyword">const</span> <span class="type"><a href="../qtcore/qurl.html">QUrl</a></span> <span class="operator">&amp;</span>url<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_url(url)<span class="operator">,</span>
      m_debug(debug)
  {
      <span class="keyword">if</span> (m_debug)
          <a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator">&lt;</span><span class="operator">&lt;</span> <span class="string">&quot;WebSocket server:&quot;</span> <span class="operator">&lt;</span><span class="operator">&lt;</span> url;
      connect(<span class="operator">&amp;</span>m_webSocket<span class="operator">,</span> <span class="operator">&amp;</span><span class="type"><a href="qwebsocket.html">QWebSocket</a></span><span class="operator">::</span>connected<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&amp;</span>EchoClient<span class="operator">::</span>onConnected);
      connect(<span class="operator">&amp;</span>m_webSocket<span class="operator">,</span> <span class="operator">&amp;</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">&amp;</span>EchoClient<span class="operator">::</span>closed);
      m_webSocket<span class="operator">.</span>open(<span class="type"><a href="../qtcore/qurl.html">QUrl</a></span>(url));
  }

</pre>
<p>After the connection, we open the socket to the given <i>url</i>.</p>
<pre class="cpp">

  <span class="type">void</span> EchoClient<span class="operator">::</span>onConnected()
  {
      <span class="keyword">if</span> (m_debug)
          <a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator">&lt;</span><span class="operator">&lt;</span> <span class="string">&quot;WebSocket connected&quot;</span>;
      connect(<span class="operator">&amp;</span>m_webSocket<span class="operator">,</span> <span class="operator">&amp;</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">&amp;</span>EchoClient<span class="operator">::</span>onTextMessageReceived);
      m_webSocket<span class="operator">.</span>sendTextMessage(<span class="type"><a href="../qtcore/qstring.html#QStringLiteral">QStringLiteral</a></span>(<span class="string">&quot;Hello, world!&quot;</span>));
  }

</pre>
<p>When the client is connected successfully, we connect to the `onTextMessageReceived()` signal, and send out &quot;Hello, world!&quot;. If connected with the EchoServer, we will receive the same message back.</p>
<pre class="cpp">

  <span class="type">void</span> EchoClient<span class="operator">::</span>onTextMessageReceived(<span class="type"><a href="../qtcore/qstring.html">QString</a></span> message)
  {
      <span class="keyword">if</span> (m_debug)
          <a href="../qtcore/qtglobal.html#qDebug">qDebug</a>() <span class="operator">&lt;</span><span class="operator">&lt;</span> <span class="string">&quot;Message received:&quot;</span> <span class="operator">&lt;</span><span class="operator">&lt;</span> message;
      m_webSocket<span class="operator">.</span>close();
  }

</pre>
<p>Whenever a message is received, we write it out.</p>
</div>
<!-- @@@echoclient.html -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 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>