Documentation/Source/eric6.Toolbox.SingleApplication.html

changeset 6632
084880ed940c
parent 3673
e26d7d0c1088
--- a/Documentation/Source/eric6.Toolbox.SingleApplication.html	Sat Dec 15 16:29:47 2018 +0100
+++ b/Documentation/Source/eric6.Toolbox.SingleApplication.html	Sat Dec 15 16:30:36 2018 +0100
@@ -95,10 +95,15 @@
 </dd>
 </dl><a NAME="SingleApplicationClient.connect" ID="SingleApplicationClient.connect"></a>
 <h4>SingleApplicationClient.connect</h4>
-<b>connect</b>(<i></i>)
+<b>connect</b>(<i>timeout=10000</i>)
 <p>
         Public method to connect the single application client to its server.
 </p><dl>
+<dt><i>timeout</i> (int)</dt>
+<dd>
+connection timeout value in milliseconds
+</dd>
+</dl><dl>
 <dt>Returns:</dt>
 <dd>
 value indicating success or an error number. Value is one of:
@@ -142,13 +147,16 @@
 </dd>
 </dl><a NAME="SingleApplicationClient.sendCommand" ID="SingleApplicationClient.sendCommand"></a>
 <h4>SingleApplicationClient.sendCommand</h4>
-<b>sendCommand</b>(<i>cmd</i>)
+<b>sendCommand</b>(<i>command, arguments</i>)
 <p>
         Public method to send the command to the application server.
 </p><dl>
-<dt><i>cmd</i></dt>
+<dt><i>command</i> (str)</dt>
 <dd>
-command to be sent (string)
+command to be sent to the server
+</dd><dt><i>arguments</i> (list of str)</dt>
+<dd>
+list of command arguments
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -180,8 +188,8 @@
 <td><a href="#SingleApplicationServer.__newConnection">__newConnection</a></td>
 <td>Private slot to handle a new connection.</td>
 </tr><tr>
-<td><a href="#SingleApplicationServer.__parseLine">__parseLine</a></td>
-<td>Private method to handle data from the client.</td>
+<td><a href="#SingleApplicationServer.__receiveJson">__receiveJson</a></td>
+<td>Private method to receive the data from the client.</td>
 </tr><tr>
 <td><a href="#SingleApplicationServer.handleCommand">handleCommand</a></td>
 <td>Public slot to handle the command sent by the client.</td>
@@ -214,25 +222,25 @@
 <b>__newConnection</b>(<i></i>)
 <p>
         Private slot to handle a new connection.
-</p><a NAME="SingleApplicationServer.__parseLine" ID="SingleApplicationServer.__parseLine"></a>
-<h4>SingleApplicationServer.__parseLine</h4>
-<b>__parseLine</b>(<i></i>)
+</p><a NAME="SingleApplicationServer.__receiveJson" ID="SingleApplicationServer.__receiveJson"></a>
+<h4>SingleApplicationServer.__receiveJson</h4>
+<b>__receiveJson</b>(<i></i>)
 <p>
-        Private method to handle data from the client.
+        Private method to receive the data from the client.
 </p><a NAME="SingleApplicationServer.handleCommand" ID="SingleApplicationServer.handleCommand"></a>
 <h4>SingleApplicationServer.handleCommand</h4>
-<b>handleCommand</b>(<i>cmd, params</i>)
+<b>handleCommand</b>(<i>command, arguments</i>)
 <p>
         Public slot to handle the command sent by the client.
 </p><p>
         <b>Note</b>: This method must be overridden by subclasses.
 </p><dl>
-<dt><i>cmd</i></dt>
+<dt><i>command</i> (str)</dt>
 <dd>
-commandstring (string)
-</dd><dt><i>params</i></dt>
+command sent by the client
+</dd><dt><i>arguments</i> (list of str)</dt>
 <dd>
-parameterstring (string)
+list of command arguments
 </dd>
 </dl><dl>
 <dt>Raises <b>RuntimeError</b>:</dt>

eric ide

mercurial