/usr/share/qt5/doc/qtwebsockets/qml-qtwebsockets-websocketserver.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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qqmlwebsocketserver.cpp -->
<title>WebSocketServer QML Type | 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 ><a href="qtwebsockets-qmlmodule.html">QML Types</a></td><td >WebSocketServer QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">WebSocketServer QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WebSocketServer-brief -->
<p>QML interface to <a href="qwebsocketserver.html">QWebSocketServer</a>. <a href="#details">More...</a></p>
<!-- @@@WebSocketServer -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWebSockets 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.3</td></tr></table></div><ul>
<li><a href="qml-qtwebsockets-websocketserver-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#accept-prop">accept</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#errorString-prop">errorString</a></b></b> : QString</li>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#host-prop">host</a></b></b> : QString</li>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#listen-prop">listen</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#name-prop">name</a></b></b> : QString</li>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#port-prop">port</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#url-prop">url</a></b></b> : QUrl</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtwebsockets-websocketserver.html#clientConnected-signal">clientConnected</a></b></b>(WebSocket <i>webSocket</i>)</li>
</ul>
<!-- $$$WebSocketServer-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<!-- @@@WebSocketServer -->
<h2>Property Documentation</h2>
<!-- $$$accept -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="accept-prop">
<td class="tblQmlPropNode"><p>
<a name="accept-prop"></a><span class="name">accept</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Set to true to accept incoming client connections when the server is listening. When set to false, incoming connections are rejected. By default, connections are accepted.</p>
</div></div><!-- @@@accept -->
<br/>
<!-- $$$errorString -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="errorString-prop">
<td class="tblQmlPropNode"><p>
<a name="errorString-prop"></a><span class="name">errorString</span> : <span class="type">QString</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The stringified error message in case an error occurred.</p>
</div></div><!-- @@@errorString -->
<br/>
<!-- $$$host -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="host-prop">
<td class="tblQmlPropNode"><p>
<a name="host-prop"></a><span class="name">host</span> : <span class="type">QString</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The host address of the server. By default, localhost is used.</p>
</div></div><!-- @@@host -->
<br/>
<!-- $$$listen -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="listen-prop">
<td class="tblQmlPropNode"><p>
<a name="listen-prop"></a><span class="name">listen</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Set to true when the server should listen to client connections or false otherwise. When set to true, the server will listen on the specified url defined by host and port and, when accept is true, accepts incoming client connections. Otherwise the server is closed. By default, the server is not listening.</p>
</div></div><!-- @@@listen -->
<br/>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-prop">
<td class="tblQmlPropNode"><p>
<a name="name-prop"></a><span class="name">name</span> : <span class="type">QString</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The name of this server used during the http handshake phase.</p>
</div></div><!-- @@@name -->
<br/>
<!-- $$$port -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="port-prop">
<td class="tblQmlPropNode"><p>
<a name="port-prop"></a><span class="name">port</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The port this server is listening on. The value must be in the range 0-65535.</p>
<p>By default, a port is chosen automatically.</p>
</div></div><!-- @@@port -->
<br/>
<!-- $$$url -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="url-prop">
<td class="tblQmlPropNode"><p>
<a name="url-prop"></a><span class="name">url</span> : <span class="type">QUrl</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Server url that client WebSockets can connect to. The url uses the <i>ws://</i> scheme and includes the port the server listens to and the host address of the server.</p>
</div></div><!-- @@@url -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$clientConnected -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="clientConnected-signal">
<td class="tblQmlFuncNode"><p>
<a name="clientConnected-signal"></a><span class="name">clientConnected</span>(<span class="type"><a href="qml-qtwebsockets-websocket.html">WebSocket</a></span> <i>webSocket</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when a client connects to this server. <i>webSocket</i> is the newly created <a href="qml-qtwebsockets-websocket.html">WebSocket</a>.</p>
</div></div><!-- @@@clientConnected -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
|