--- a/src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonServer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonServer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricNetwork.EricJsonServer</h1>
-
<p>
Module implementing the JSON based server base class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricJsonServer">EricJsonServer</a></td>
<td>Class implementing a JSON based server base class.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricJsonServer" ID="EricJsonServer"></a>
<h2>EricJsonServer</h2>
-
<p>
Class implementing a JSON based server base class.
</p>
+
<h3>Derived from</h3>
QTcpServer
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#EricJsonServer.__init__">EricJsonServer</a></td>
<td>Constructor</td>
@@ -95,19 +92,20 @@
<td>Public method to stop a client process.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricJsonServer.__init__" ID="EricJsonServer.__init__"></a>
<h4>EricJsonServer (Constructor)</h4>
<b>EricJsonServer</b>(<i>name="", multiplex=False, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -126,10 +124,10 @@
<a NAME="EricJsonServer.__handleDisconnect" ID="EricJsonServer.__handleDisconnect"></a>
<h4>EricJsonServer.__handleDisconnect</h4>
<b>__handleDisconnect</b>(<i>idString</i>)
-
<p>
Private slot handling a disconnect of the client.
</p>
+
<dl>
<dt><i>idString</i> (str)</dt>
@@ -140,10 +138,10 @@
<a NAME="EricJsonServer.__receiveJson" ID="EricJsonServer.__receiveJson"></a>
<h4>EricJsonServer.__receiveJson</h4>
<b>__receiveJson</b>(<i>idString</i>)
-
<p>
Private slot handling received data from the client.
</p>
+
<dl>
<dt><i>idString</i> (str)</dt>
@@ -154,13 +152,13 @@
<a NAME="EricJsonServer.connectionNames" ID="EricJsonServer.connectionNames"></a>
<h4>EricJsonServer.connectionNames</h4>
<b>connectionNames</b>(<i></i>)
-
<p>
Public method to get the list of active connection names.
</p>
<p>
If this is not a multiplexing server, an empty list is returned.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -176,7 +174,6 @@
<a NAME="EricJsonServer.handleCall" ID="EricJsonServer.handleCall"></a>
<h4>EricJsonServer.handleCall</h4>
<b>handleCall</b>(<i>method, params</i>)
-
<p>
Public method to handle a method call from the client.
</p>
@@ -184,6 +181,7 @@
Note: This is an empty implementation that must be overridden in
derived classes.
</p>
+
<dl>
<dt><i>method</i> (str)</dt>
@@ -198,17 +196,17 @@
<a NAME="EricJsonServer.handleNewConnection" ID="EricJsonServer.handleNewConnection"></a>
<h4>EricJsonServer.handleNewConnection</h4>
<b>handleNewConnection</b>(<i></i>)
-
<p>
Public slot for new incoming connections from a client.
</p>
+
<a NAME="EricJsonServer.sendJson" ID="EricJsonServer.sendJson"></a>
<h4>EricJsonServer.sendJson</h4>
<b>sendJson</b>(<i>command, params, flush=False, idString=""</i>)
-
<p>
Public method to send a single command to a client.
</p>
+
<dl>
<dt><i>command</i> (str)</dt>
@@ -231,10 +229,10 @@
<a NAME="EricJsonServer.startClient" ID="EricJsonServer.startClient"></a>
<h4>EricJsonServer.startClient</h4>
<b>startClient</b>(<i>interpreter, clientScript, clientArgs, idString="", environment=None</i>)
-
<p>
Public method to start a client process.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -274,17 +272,17 @@
<a NAME="EricJsonServer.stopAllClients" ID="EricJsonServer.stopAllClients"></a>
<h4>EricJsonServer.stopAllClients</h4>
<b>stopAllClients</b>(<i></i>)
-
<p>
Public method to stop all clients.
</p>
+
<a NAME="EricJsonServer.stopClient" ID="EricJsonServer.stopClient"></a>
<h4>EricJsonServer.stopClient</h4>
<b>stopClient</b>(<i>idString=""</i>)
-
<p>
Public method to stop a client process.
</p>
+
<dl>
<dt><i>idString</i> (str)</dt>
@@ -294,4 +292,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
