Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerDebuggerInterface.html
src/eric7/Documentation/Source/eric7.RemoteServerInterface.EricServerDebuggerInterface.html
- branch
- eric7
- changeset 10784
- 521fd465b048
- child 10962
- b56b76c0221b
equal
deleted
inserted
replaced
| 10783:ccf28bec1227 | 10784:521fd465b048 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.RemoteServerInterface.EricServerDebuggerInterface</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.RemoteServerInterface.EricServerDebuggerInterface</h1> | |
| 10 <p> | |
| 11 Module implementing the file system interface to 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="#EricServerDebuggerInterface">EricServerDebuggerInterface</a></td> | |
| 23 <td>Class implementing the file system interface to 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="EricServerDebuggerInterface" ID="EricServerDebuggerInterface"></a> | |
| 35 <h2>EricServerDebuggerInterface</h2> | |
| 36 <p> | |
| 37 Class implementing the file system interface to the eric-ide server. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Signals</h3> | |
| 41 <dl> | |
| 42 | |
| 43 <dt>debugClientDisconnected(debuggerId:str)</dt> | |
| 44 <dd> | |
| 45 emitted when a remote debug | |
| 46 client did disconnect from the eric-ide server | |
| 47 </dd> | |
| 48 <dt>debugClientResponse(response:str)</dt> | |
| 49 <dd> | |
| 50 emitted to relay a response of | |
| 51 the remote debug client | |
| 52 </dd> | |
| 53 <dt>lastClientExited()</dt> | |
| 54 <dd> | |
| 55 emitted to indicate that the last debug client of | |
| 56 the eric-ide server exited | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <h3>Derived from</h3> | |
| 60 QObject | |
| 61 <h3>Class Attributes</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 | |
| 66 <h3>Class Methods</h3> | |
| 67 <table> | |
| 68 <tr><td>None</td></tr> | |
| 69 </table> | |
| 70 | |
| 71 <h3>Methods</h3> | |
| 72 <table> | |
| 73 <tr> | |
| 74 <td><a href="#EricServerDebuggerInterface.__init__">EricServerDebuggerInterface</a></td> | |
| 75 <td>Constructor</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#EricServerDebuggerInterface.__handleDbgClientDisconnected">__handleDbgClientDisconnected</a></td> | |
| 79 <td>Private method to handle a debug client disconnect report of the eric-ide server.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#EricServerDebuggerInterface.__handleDbgClientResponse">__handleDbgClientResponse</a></td> | |
| 83 <td>Private method to handle a response from a debug client connected to the eric-ide server.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#EricServerDebuggerInterface.__handleDbgRequestError">__handleDbgRequestError</a></td> | |
| 87 <td>Private method to handle an error reported by the debugger interface of the eric-ide server.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#EricServerDebuggerInterface.__handleDebuggerReply">__handleDebuggerReply</a></td> | |
| 91 <td>Private slot to handle a debugger reply from the eric-ide server.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#EricServerDebuggerInterface.__handleLastDbgClientExited">__handleLastDbgClientExited</a></td> | |
| 95 <td>Private method to handle a report of the eric-ide server, that the last debug client has disconnected.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#EricServerDebuggerInterface.__handleMainClientExited">__handleMainClientExited</a></td> | |
| 99 <td>Private method to handle the main client exiting.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#EricServerDebuggerInterface.callback">callback</a></td> | |
| 103 <td>Function to handle the server reply</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#EricServerDebuggerInterface.sendClientCommand">sendClientCommand</a></td> | |
| 107 <td>Public method to rely a debug client command via the eric-ide server.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#EricServerDebuggerInterface.startClient">startClient</a></td> | |
| 111 <td>Public method to send a command to start a debug client.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#EricServerDebuggerInterface.stopClient">stopClient</a></td> | |
| 115 <td>Public method to stop the debug client synchronously.</td> | |
| 116 </tr> | |
| 117 </table> | |
| 118 | |
| 119 <h3>Static Methods</h3> | |
| 120 <table> | |
| 121 <tr><td>None</td></tr> | |
| 122 </table> | |
| 123 | |
| 124 | |
| 125 <a NAME="EricServerDebuggerInterface.__init__" ID="EricServerDebuggerInterface.__init__"></a> | |
| 126 <h4>EricServerDebuggerInterface (Constructor)</h4> | |
| 127 <b>EricServerDebuggerInterface</b>(<i>serverInterface</i>) | |
| 128 <p> | |
| 129 Constructor | |
| 130 </p> | |
| 131 | |
| 132 <dl> | |
| 133 | |
| 134 <dt><i>serverInterface</i> (EricServerInterface)</dt> | |
| 135 <dd> | |
| 136 reference to the eric-ide server interface | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="EricServerDebuggerInterface.__handleDbgClientDisconnected" ID="EricServerDebuggerInterface.__handleDbgClientDisconnected"></a> | |
| 140 <h4>EricServerDebuggerInterface.__handleDbgClientDisconnected</h4> | |
| 141 <b>__handleDbgClientDisconnected</b>(<i>params</i>) | |
| 142 <p> | |
| 143 Private method to handle a debug client disconnect report of the | |
| 144 eric-ide server. | |
| 145 </p> | |
| 146 | |
| 147 <dl> | |
| 148 | |
| 149 <dt><i>params</i> (dict)</dt> | |
| 150 <dd> | |
| 151 dictionary containing the reply data | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <a NAME="EricServerDebuggerInterface.__handleDbgClientResponse" ID="EricServerDebuggerInterface.__handleDbgClientResponse"></a> | |
| 155 <h4>EricServerDebuggerInterface.__handleDbgClientResponse</h4> | |
| 156 <b>__handleDbgClientResponse</b>(<i>params</i>) | |
| 157 <p> | |
| 158 Private method to handle a response from a debug client connected to the | |
| 159 eric-ide server. | |
| 160 </p> | |
| 161 | |
| 162 <dl> | |
| 163 | |
| 164 <dt><i>params</i> (dict)</dt> | |
| 165 <dd> | |
| 166 dictionary containing the reply data | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <a NAME="EricServerDebuggerInterface.__handleDbgRequestError" ID="EricServerDebuggerInterface.__handleDbgRequestError"></a> | |
| 170 <h4>EricServerDebuggerInterface.__handleDbgRequestError</h4> | |
| 171 <b>__handleDbgRequestError</b>(<i>params</i>) | |
| 172 <p> | |
| 173 Private method to handle an error reported by the debugger interface of | |
| 174 the eric-ide server. | |
| 175 </p> | |
| 176 | |
| 177 <dl> | |
| 178 | |
| 179 <dt><i>params</i> (dict)</dt> | |
| 180 <dd> | |
| 181 dictionary containing the reply data | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <a NAME="EricServerDebuggerInterface.__handleDebuggerReply" ID="EricServerDebuggerInterface.__handleDebuggerReply"></a> | |
| 185 <h4>EricServerDebuggerInterface.__handleDebuggerReply</h4> | |
| 186 <b>__handleDebuggerReply</b>(<i>reply, params</i>) | |
| 187 <p> | |
| 188 Private slot to handle a debugger reply from the eric-ide server. | |
| 189 </p> | |
| 190 | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>reply</i> (str)</dt> | |
| 194 <dd> | |
| 195 name of the server reply | |
| 196 </dd> | |
| 197 <dt><i>params</i> (dict)</dt> | |
| 198 <dd> | |
| 199 dictionary containing the reply data | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <a NAME="EricServerDebuggerInterface.__handleLastDbgClientExited" ID="EricServerDebuggerInterface.__handleLastDbgClientExited"></a> | |
| 203 <h4>EricServerDebuggerInterface.__handleLastDbgClientExited</h4> | |
| 204 <b>__handleLastDbgClientExited</b>(<i>params</i>) | |
| 205 <p> | |
| 206 Private method to handle a report of the eric-ide server, that the last | |
| 207 debug client has disconnected. | |
| 208 </p> | |
| 209 | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>params</i> (dict)</dt> | |
| 213 <dd> | |
| 214 dictionary containing the reply data | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="EricServerDebuggerInterface.__handleMainClientExited" ID="EricServerDebuggerInterface.__handleMainClientExited"></a> | |
| 218 <h4>EricServerDebuggerInterface.__handleMainClientExited</h4> | |
| 219 <b>__handleMainClientExited</b>(<i>params</i>) | |
| 220 <p> | |
| 221 Private method to handle the main client exiting. | |
| 222 </p> | |
| 223 | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>params</i> (dict)</dt> | |
| 227 <dd> | |
| 228 dictionary containing the reply data | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <a NAME="EricServerDebuggerInterface.callback" ID="EricServerDebuggerInterface.callback"></a> | |
| 232 <h4>EricServerDebuggerInterface.callback</h4> | |
| 233 <b>callback</b>(<i>params</i>) | |
| 234 <p> | |
| 235 Function to handle the server reply | |
| 236 </p> | |
| 237 | |
| 238 <dl> | |
| 239 | |
| 240 <dt><i>reply</i> (str)</dt> | |
| 241 <dd> | |
| 242 name of the server reply | |
| 243 </dd> | |
| 244 <dt><i>params</i> (dict)</dt> | |
| 245 <dd> | |
| 246 dictionary containing the reply data | |
| 247 </dd> | |
| 248 </dl> | |
| 249 <a NAME="EricServerDebuggerInterface.sendClientCommand" ID="EricServerDebuggerInterface.sendClientCommand"></a> | |
| 250 <h4>EricServerDebuggerInterface.sendClientCommand</h4> | |
| 251 <b>sendClientCommand</b>(<i>debuggerId, jsonCommand</i>) | |
| 252 <p> | |
| 253 Public method to rely a debug client command via the eric-ide server. | |
| 254 </p> | |
| 255 | |
| 256 <dl> | |
| 257 | |
| 258 <dt><i>debuggerId</i> (str)</dt> | |
| 259 <dd> | |
| 260 id of the debug client to send the command to | |
| 261 </dd> | |
| 262 <dt><i>jsonCommand</i> (str)</dt> | |
| 263 <dd> | |
| 264 JSON encoded command dictionary to be relayed | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <a NAME="EricServerDebuggerInterface.startClient" ID="EricServerDebuggerInterface.startClient"></a> | |
| 268 <h4>EricServerDebuggerInterface.startClient</h4> | |
| 269 <b>startClient</b>(<i>interpreter, originalPathString, args, workingDir=""</i>) | |
| 270 <p> | |
| 271 Public method to send a command to start a debug client. | |
| 272 </p> | |
| 273 | |
| 274 <dl> | |
| 275 | |
| 276 <dt><i>interpreter</i> (str)</dt> | |
| 277 <dd> | |
| 278 path of the remote interpreter to be used | |
| 279 </dd> | |
| 280 <dt><i>originalPathString</i> (str)</dt> | |
| 281 <dd> | |
| 282 original PATH environment variable | |
| 283 </dd> | |
| 284 <dt><i>args</i> (list of str)</dt> | |
| 285 <dd> | |
| 286 list of command line parameters for the debug client | |
| 287 </dd> | |
| 288 <dt><i>workingDir</i> (str (optional))</dt> | |
| 289 <dd> | |
| 290 directory to start the debugger client in (defaults to "") | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <a NAME="EricServerDebuggerInterface.stopClient" ID="EricServerDebuggerInterface.stopClient"></a> | |
| 294 <h4>EricServerDebuggerInterface.stopClient</h4> | |
| 295 <b>stopClient</b>(<i></i>) | |
| 296 <p> | |
| 297 Public method to stop the debug client synchronously. | |
| 298 </p> | |
| 299 | |
| 300 <div align="right"><a href="#top">Up</a></div> | |
| 301 <hr /> | |
| 302 </body></html> |
