eric6/Documentation/Source/eric6.Cooperation.CooperationServer.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Cooperation.CooperationServer</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Cooperation.CooperationServer</h1>
23 <p>
24 Module implementing the cooperation server.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#CooperationServer">CooperationServer</a></td>
34 <td>Class implementing the cooperation server.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="CooperationServer" ID="CooperationServer"></a>
43 <h2>CooperationServer</h2>
44 <p>
45 Class implementing the cooperation server.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>newConnection(connection)</dt>
49 <dd>
50 emitted after a new connection was
51 received (Connection)
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QTcpServer
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#CooperationServer.__init__">CooperationServer</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#CooperationServer.incomingConnection">incomingConnection</a></td>
71 <td>Public method handling an incoming connection.</td>
72 </tr><tr>
73 <td><a href="#CooperationServer.startListening">startListening</a></td>
74 <td>Public method to start listening for new connections.</td>
75 </tr>
76 </table>
77 <h3>Static Methods</h3>
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <a NAME="CooperationServer.__init__" ID="CooperationServer.__init__"></a>
82 <h4>CooperationServer (Constructor)</h4>
83 <b>CooperationServer</b>(<i>address, parent=None</i>)
84 <p>
85 Constructor
86 </p><dl>
87 <dt><i>address</i></dt>
88 <dd>
89 address the server should listen on (QHostAddress)
90 </dd><dt><i>parent</i></dt>
91 <dd>
92 reference to the parent object (QObject)
93 </dd>
94 </dl><a NAME="CooperationServer.incomingConnection" ID="CooperationServer.incomingConnection"></a>
95 <h4>CooperationServer.incomingConnection</h4>
96 <b>incomingConnection</b>(<i>socketDescriptor</i>)
97 <p>
98 Public method handling an incoming connection.
99 </p><dl>
100 <dt><i>socketDescriptor</i></dt>
101 <dd>
102 native socket descriptor (integer)
103 </dd>
104 </dl><a NAME="CooperationServer.startListening" ID="CooperationServer.startListening"></a>
105 <h4>CooperationServer.startListening</h4>
106 <b>startListening</b>(<i>port=-1, findFreePort=False</i>)
107 <p>
108 Public method to start listening for new connections.
109 </p><dl>
110 <dt><i>port</i></dt>
111 <dd>
112 port to listen on (integer)
113 </dd><dt><i>findFreePort</i></dt>
114 <dd>
115 flag indicating to search for a free port
116 depending on the configuration (boolean)
117 </dd>
118 </dl><dl>
119 <dt>Returns:</dt>
120 <dd>
121 tuple giving a flag indicating success (boolean) and
122 the port the server listens on
123 </dd>
124 </dl>
125 <div align="right"><a href="#top">Up</a></div>
126 <hr />
127 </body></html>

eric ide

mercurial