Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric5.Cooperation.CooperationClient.html	Thu Aug 18 12:36:53 2011 +0200
+++ b/Documentation/Source/eric5.Cooperation.CooperationClient.html	Thu Aug 18 18:03:22 2011 +0200
@@ -110,18 +110,30 @@
 <td><a href="#CooperationClient.banUser">banUser</a></td>
 <td>Public method to ban a user by its nick name.</td>
 </tr><tr>
+<td><a href="#CooperationClient.chatWidget">chatWidget</a></td>
+<td>Public method to get a reference to the chat widget.</td>
+</tr><tr>
+<td><a href="#CooperationClient.close">close</a></td>
+<td>Public method to close all connections and stop listening.</td>
+</tr><tr>
 <td><a href="#CooperationClient.connectToHost">connectToHost</a></td>
 <td>Public method to connect to a host.</td>
 </tr><tr>
 <td><a href="#CooperationClient.disconnectConnections">disconnectConnections</a></td>
 <td>Public slot to disconnect from the chat network.</td>
 </tr><tr>
+<td><a href="#CooperationClient.errorString">errorString</a></td>
+<td>Public method to get a human readable error message about the last server error.</td>
+</tr><tr>
 <td><a href="#CooperationClient.hasConnection">hasConnection</a></td>
 <td>Public method to check for an existing connection.</td>
 </tr><tr>
 <td><a href="#CooperationClient.hasConnections">hasConnections</a></td>
 <td>Public method to check, if there are any connections established.</td>
 </tr><tr>
+<td><a href="#CooperationClient.isListening">isListening</a></td>
+<td>Public method to check, if the client is listening for connections.</td>
+</tr><tr>
 <td><a href="#CooperationClient.kickUser">kickUser</a></td>
 <td>Public method to kick a user by its nick name.</td>
 </tr><tr>
@@ -137,8 +149,8 @@
 <td><a href="#CooperationClient.sendMessage">sendMessage</a></td>
 <td>Public method to send a message.</td>
 </tr><tr>
-<td><a href="#CooperationClient.server">server</a></td>
-<td>Public method to get a reference to the server.</td>
+<td><a href="#CooperationClient.startListening">startListening</a></td>
+<td>Public method to start listening for new connections.</td>
 </tr>
 </table>
 <a NAME="CooperationClient.__init__" ID="CooperationClient.__init__"></a>
@@ -241,7 +253,22 @@
 <dd>
 nick name in the format of self.nickName() (string)
 </dd>
-</dl><a NAME="CooperationClient.connectToHost" ID="CooperationClient.connectToHost"></a>
+</dl><a NAME="CooperationClient.chatWidget" ID="CooperationClient.chatWidget"></a>
+<h4>CooperationClient.chatWidget</h4>
+<b>chatWidget</b>(<i></i>)
+<p>
+        Public method to get a reference to the chat widget.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the chat widget (ChatWidget)
+</dd>
+</dl><a NAME="CooperationClient.close" ID="CooperationClient.close"></a>
+<h4>CooperationClient.close</h4>
+<b>close</b>(<i></i>)
+<p>
+        Public method to close all connections and stop listening.
+</p><a NAME="CooperationClient.connectToHost" ID="CooperationClient.connectToHost"></a>
 <h4>CooperationClient.connectToHost</h4>
 <b>connectToHost</b>(<i>host, port</i>)
 <p>
@@ -259,7 +286,17 @@
 <b>disconnectConnections</b>(<i></i>)
 <p>
         Public slot to disconnect from the chat network.
-</p><a NAME="CooperationClient.hasConnection" ID="CooperationClient.hasConnection"></a>
+</p><a NAME="CooperationClient.errorString" ID="CooperationClient.errorString"></a>
+<h4>CooperationClient.errorString</h4>
+<b>errorString</b>(<i></i>)
+<p>
+        Public method to get a human readable error message about the last server error.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+human readable error message about the last server error (string)
+</dd>
+</dl><a NAME="CooperationClient.hasConnection" ID="CooperationClient.hasConnection"></a>
 <h4>CooperationClient.hasConnection</h4>
 <b>hasConnection</b>(<i>senderIp, senderPort=-1</i>)
 <p>
@@ -287,6 +324,16 @@
 <dd>
 flag indicating the presence of connections (boolean)
 </dd>
+</dl><a NAME="CooperationClient.isListening" ID="CooperationClient.isListening"></a>
+<h4>CooperationClient.isListening</h4>
+<b>isListening</b>(<i></i>)
+<p>
+        Public method to check, if the client is listening for connections.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating the listening state (boolean)
+</dd>
 </dl><a NAME="CooperationClient.kickUser" ID="CooperationClient.kickUser"></a>
 <h4>CooperationClient.kickUser</h4>
 <b>kickUser</b>(<i>nick</i>)
@@ -344,15 +391,21 @@
 <dd>
 message to be sent (string)
 </dd>
-</dl><a NAME="CooperationClient.server" ID="CooperationClient.server"></a>
-<h4>CooperationClient.server</h4>
-<b>server</b>(<i></i>)
+</dl><a NAME="CooperationClient.startListening" ID="CooperationClient.startListening"></a>
+<h4>CooperationClient.startListening</h4>
+<b>startListening</b>(<i>port=-1</i>)
 <p>
-        Public method to get a reference to the server.
+        Public method to start listening for new connections.
 </p><dl>
+<dt><i>port</i></dt>
+<dd>
+port to listen on (integer)
+</dd>
+</dl><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the server object (CooperationServer)
+tuple giving a flag indicating success (boolean) and
+            the port the server listens on
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>