Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.RemoteServer.EricServerDebuggerRequestHandler.html
src/eric7/Documentation/Source/eric7.RemoteServer.EricServerDebuggerRequestHandler.html
- branch
- eric7
- changeset 10784
- 521fd465b048
- child 10958
- 79842be466d3
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.RemoteServer.EricServerDebuggerRequestHandler</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.RemoteServer.EricServerDebuggerRequestHandler</h1> | |
| 10 <p> | |
| 11 Module implementing the debugger request handler of the eric-ide server. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#EricServerDebuggerRequestHandler">EricServerDebuggerRequestHandler</a></td> | |
| 23 <td>Class implementing the debugger request handler of the eric-ide server.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="EricServerDebuggerRequestHandler" ID="EricServerDebuggerRequestHandler"></a> | |
| 35 <h2>EricServerDebuggerRequestHandler</h2> | |
| 36 <p> | |
| 37 Class implementing the debugger request handler of the eric-ide server. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 EricServerBaseRequestHandler | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>None</td></tr> | |
| 45 </table> | |
| 46 | |
| 47 <h3>Class Methods</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#EricServerDebuggerRequestHandler.__init__">EricServerDebuggerRequestHandler</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#EricServerDebuggerRequestHandler.__acceptDbgClientConnection">__acceptDbgClientConnection</a></td> | |
| 60 <td>Private method to accept the connection on the listening debug server socket.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#EricServerDebuggerRequestHandler.__clientSocketDisconnected">__clientSocketDisconnected</a></td> | |
| 64 <td>Private method handling a socket disconnecting.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#EricServerDebuggerRequestHandler.__mainClientExited">__mainClientExited</a></td> | |
| 68 <td>Private method to handle exiting of the main debug client.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#EricServerDebuggerRequestHandler.__prepareClientCommand">__prepareClientCommand</a></td> | |
| 72 <td>Private method to prepare a command dictionary for the debug client.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#EricServerDebuggerRequestHandler.__relayDebugClientCommand">__relayDebugClientCommand</a></td> | |
| 76 <td>Private method to relay a debug client command to the client.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#EricServerDebuggerRequestHandler.__serviceDbgClientConnection">__serviceDbgClientConnection</a></td> | |
| 80 <td>Private method to service the debug client connection.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#EricServerDebuggerRequestHandler.__shutdownSocket">__shutdownSocket</a></td> | |
| 84 <td>Private method to shut down a socket.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#EricServerDebuggerRequestHandler.__startClient">__startClient</a></td> | |
| 88 <td>Private method to start a debug client process.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#EricServerDebuggerRequestHandler.__stopClient">__stopClient</a></td> | |
| 92 <td>Private method to stop the current debug client process.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#EricServerDebuggerRequestHandler.initServerSocket">initServerSocket</a></td> | |
| 96 <td>Public method to initialize the server socket listening for debug client connections.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#EricServerDebuggerRequestHandler.shutdownClients">shutdownClients</a></td> | |
| 100 <td>Public method to shut down all connected clients.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 | |
| 104 <h3>Static Methods</h3> | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 | |
| 109 | |
| 110 <a NAME="EricServerDebuggerRequestHandler.__init__" ID="EricServerDebuggerRequestHandler.__init__"></a> | |
| 111 <h4>EricServerDebuggerRequestHandler (Constructor)</h4> | |
| 112 <b>EricServerDebuggerRequestHandler</b>(<i>server</i>) | |
| 113 <p> | |
| 114 Constructor | |
| 115 </p> | |
| 116 | |
| 117 <dl> | |
| 118 | |
| 119 <dt><i>server</i> (EricServer)</dt> | |
| 120 <dd> | |
| 121 reference to the eric-ide server object | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="EricServerDebuggerRequestHandler.__acceptDbgClientConnection" ID="EricServerDebuggerRequestHandler.__acceptDbgClientConnection"></a> | |
| 125 <h4>EricServerDebuggerRequestHandler.__acceptDbgClientConnection</h4> | |
| 126 <b>__acceptDbgClientConnection</b>(<i>sock</i>) | |
| 127 <p> | |
| 128 Private method to accept the connection on the listening debug server socket. | |
| 129 </p> | |
| 130 | |
| 131 <dl> | |
| 132 | |
| 133 <dt><i>sock</i> (socket.socket)</dt> | |
| 134 <dd> | |
| 135 reference to the listening socket | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <a NAME="EricServerDebuggerRequestHandler.__clientSocketDisconnected" ID="EricServerDebuggerRequestHandler.__clientSocketDisconnected"></a> | |
| 139 <h4>EricServerDebuggerRequestHandler.__clientSocketDisconnected</h4> | |
| 140 <b>__clientSocketDisconnected</b>(<i>sock</i>) | |
| 141 <p> | |
| 142 Private method handling a socket disconnecting. | |
| 143 </p> | |
| 144 | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>sock</i> (socket.socket)</dt> | |
| 148 <dd> | |
| 149 reference to the disconnected socket | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="EricServerDebuggerRequestHandler.__mainClientExited" ID="EricServerDebuggerRequestHandler.__mainClientExited"></a> | |
| 153 <h4>EricServerDebuggerRequestHandler.__mainClientExited</h4> | |
| 154 <b>__mainClientExited</b>(<i></i>) | |
| 155 <p> | |
| 156 Private method to handle exiting of the main debug client. | |
| 157 </p> | |
| 158 | |
| 159 <a NAME="EricServerDebuggerRequestHandler.__prepareClientCommand" ID="EricServerDebuggerRequestHandler.__prepareClientCommand"></a> | |
| 160 <h4>EricServerDebuggerRequestHandler.__prepareClientCommand</h4> | |
| 161 <b>__prepareClientCommand</b>(<i>command, params</i>) | |
| 162 <p> | |
| 163 Private method to prepare a command dictionary for the debug client. | |
| 164 </p> | |
| 165 | |
| 166 <dl> | |
| 167 | |
| 168 <dt><i>command</i> (str)</dt> | |
| 169 <dd> | |
| 170 command to be sent | |
| 171 </dd> | |
| 172 <dt><i>params</i> (dict)</dt> | |
| 173 <dd> | |
| 174 dictionary containing the command parameters | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return:</dt> | |
| 179 <dd> | |
| 180 completed command dictionary to be sent to the debug client | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <dl> | |
| 184 <dt>Return Type:</dt> | |
| 185 <dd> | |
| 186 dict | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <a NAME="EricServerDebuggerRequestHandler.__relayDebugClientCommand" ID="EricServerDebuggerRequestHandler.__relayDebugClientCommand"></a> | |
| 190 <h4>EricServerDebuggerRequestHandler.__relayDebugClientCommand</h4> | |
| 191 <b>__relayDebugClientCommand</b>(<i>params</i>) | |
| 192 <p> | |
| 193 Private method to relay a debug client command to the client. | |
| 194 </p> | |
| 195 | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>params</i> (dict)</dt> | |
| 199 <dd> | |
| 200 dictionary containing the request data | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="EricServerDebuggerRequestHandler.__serviceDbgClientConnection" ID="EricServerDebuggerRequestHandler.__serviceDbgClientConnection"></a> | |
| 204 <h4>EricServerDebuggerRequestHandler.__serviceDbgClientConnection</h4> | |
| 205 <b>__serviceDbgClientConnection</b>(<i>key</i>) | |
| 206 <p> | |
| 207 Private method to service the debug client connection. | |
| 208 </p> | |
| 209 | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>key</i> (selectors.SelectorKey)</dt> | |
| 213 <dd> | |
| 214 reference to the SelectorKey object associated with the connection | |
| 215 to be serviced | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="EricServerDebuggerRequestHandler.__shutdownSocket" ID="EricServerDebuggerRequestHandler.__shutdownSocket"></a> | |
| 219 <h4>EricServerDebuggerRequestHandler.__shutdownSocket</h4> | |
| 220 <b>__shutdownSocket</b>(<i>debuggerId, sock</i>) | |
| 221 <p> | |
| 222 Private method to shut down a socket. | |
| 223 </p> | |
| 224 | |
| 225 <dl> | |
| 226 | |
| 227 <dt><i>debuggerId</i> (str)</dt> | |
| 228 <dd> | |
| 229 ID of the debugger the socket belongs to | |
| 230 </dd> | |
| 231 <dt><i>sock</i> (socket.socket)</dt> | |
| 232 <dd> | |
| 233 reference to the socket | |
| 234 </dd> | |
| 235 </dl> | |
| 236 <a NAME="EricServerDebuggerRequestHandler.__startClient" ID="EricServerDebuggerRequestHandler.__startClient"></a> | |
| 237 <h4>EricServerDebuggerRequestHandler.__startClient</h4> | |
| 238 <b>__startClient</b>(<i>params</i>) | |
| 239 <p> | |
| 240 Private method to start a debug client process. | |
| 241 </p> | |
| 242 | |
| 243 <dl> | |
| 244 | |
| 245 <dt><i>params</i> (dict)</dt> | |
| 246 <dd> | |
| 247 dictionary containing the request data | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <a NAME="EricServerDebuggerRequestHandler.__stopClient" ID="EricServerDebuggerRequestHandler.__stopClient"></a> | |
| 251 <h4>EricServerDebuggerRequestHandler.__stopClient</h4> | |
| 252 <b>__stopClient</b>(<i>params</i>) | |
| 253 <p> | |
| 254 Private method to stop the current debug client process. | |
| 255 </p> | |
| 256 | |
| 257 <dl> | |
| 258 | |
| 259 <dt><i>params</i> (dict)</dt> | |
| 260 <dd> | |
| 261 dictionary containing the request data | |
| 262 </dd> | |
| 263 </dl> | |
| 264 <dl> | |
| 265 <dt>Return:</dt> | |
| 266 <dd> | |
| 267 dictionary containing the reply data | |
| 268 </dd> | |
| 269 </dl> | |
| 270 <dl> | |
| 271 <dt>Return Type:</dt> | |
| 272 <dd> | |
| 273 dict | |
| 274 </dd> | |
| 275 </dl> | |
| 276 <a NAME="EricServerDebuggerRequestHandler.initServerSocket" ID="EricServerDebuggerRequestHandler.initServerSocket"></a> | |
| 277 <h4>EricServerDebuggerRequestHandler.initServerSocket</h4> | |
| 278 <b>initServerSocket</b>(<i></i>) | |
| 279 <p> | |
| 280 Public method to initialize the server socket listening for debug client | |
| 281 connections. | |
| 282 </p> | |
| 283 | |
| 284 <a NAME="EricServerDebuggerRequestHandler.shutdownClients" ID="EricServerDebuggerRequestHandler.shutdownClients"></a> | |
| 285 <h4>EricServerDebuggerRequestHandler.shutdownClients</h4> | |
| 286 <b>shutdownClients</b>(<i></i>) | |
| 287 <p> | |
| 288 Public method to shut down all connected clients. | |
| 289 </p> | |
| 290 | |
| 291 <div align="right"><a href="#top">Up</a></div> | |
| 292 <hr /> | |
| 293 </body></html> |
