/usr/share/qt5/doc/qtwebsockets/qtwebsockets-index.html is in qtwebsockets5-doc-html 5.7.1~20161021-4.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- index.qdoc -->
<title>Qt WebSockets 5.7</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
window.onload = function(){document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");};
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.7</td><td >Qt WebSockets</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.7.1 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="#getting-started">Getting Started</a></li>
<li class="level1"><a href="#reference-documentation">Reference Documentation</a></li>
<li class="level1"><a href="#examples">Examples</a></li>
<li class="level1"><a href="#conformance">Conformance</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt WebSockets</h1>
<span class="subtitle"></span>
<!-- $$$qtwebsockets-index.html-description -->
<div class="descr"> <a name="details"></a>
<p>WebSocket is a web-based protocol designed to enable two-way communication between a client application and a remote host. It enables the two entities to send data back and forth if the initial handshake succeeds. WebSocket is the solution for applications that struggle to get real-time data feeds with less network latency and minimum data exchange.</p>
<p>The Qt WebSockets module provides C++ and QML interfaces that enable Qt applications to act as a server that can process WebSocket requests, or a client that can consume data received from the server, or both.</p>
<a name="getting-started"></a>
<h2 id="getting-started">Getting Started</h2>
<p>To include the definitions of the module's classes, use the following directive:</p>
<pre class="cpp">
<span class="preprocessor">#include <QtWebSockets/QtWebSockets></span>
</pre>
<p>To import the QML types into your application, use the following import statement in your .qml file:</p>
<pre class="cpp">
import <span class="type">QtWebSockets</span> <span class="number">1.0</span>
</pre>
<p>To link against the module, add this line to your qmake .pro file:</p>
<pre class="cpp">
QT <span class="operator">+</span><span class="operator">=</span> websockets
</pre>
<a name="reference-documentation"></a>
<h2 id="reference-documentation">Reference Documentation</h2>
<ul>
<li><a href="websockets-overview.html">Overview</a></li>
<li><a href="qtwebsockets-module.html">C++ Classes</a></li>
<li><a href="qtwebsockets-qmlmodule.html">QML Types</a></li>
</ul>
<a name="examples"></a>
<h2 id="examples">Examples</h2>
<p>The module provides the following <a href="qtwebsockets-examples.html">Examples</a> as a guide to using the API.</p>
<a name="conformance"></a>
<h2 id="conformance">Conformance</h2>
<ul>
<li><a href="qtwebsockets-testing.html">Testing Qt WebSockets</a></li>
</ul>
</div>
<!-- @@@qtwebsockets-index.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2016 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>
|