src/eric7/Documentation/Source/eric7.Debugger.DebugServer.html

branch
eric7
changeset 10784
521fd465b048
parent 10684
58c7f23ae1cb
child 10987
ee81b245ae2c
equal deleted inserted replaced
10783:ccf28bec1227 10784:521fd465b048
362 <tr> 362 <tr>
363 <td><a href="#DebugServer.getDebuggerIds">getDebuggerIds</a></td> 363 <td><a href="#DebugServer.getDebuggerIds">getDebuggerIds</a></td>
364 <td>Public method to return the IDs of the connected debugger backends.</td> 364 <td>Public method to return the IDs of the connected debugger backends.</td>
365 </tr> 365 </tr>
366 <tr> 366 <tr>
367 <td><a href="#DebugServer.getEricServerEnvironmentString">getEricServerEnvironmentString</a></td>
368 <td>Public method to get the string for an eric-ide server environment.</td>
369 </tr>
370 <tr>
367 <td><a href="#DebugServer.getExtensions">getExtensions</a></td> 371 <td><a href="#DebugServer.getExtensions">getExtensions</a></td>
368 <td>Public slot to get the extensions associated with the given language.</td> 372 <td>Public slot to get the extensions associated with the given language.</td>
369 </tr> 373 </tr>
370 <tr> 374 <tr>
371 <td><a href="#DebugServer.getHostAddress">getHostAddress</a></td> 375 <td><a href="#DebugServer.getHostAddress">getHostAddress</a></td>
387 <td><a href="#DebugServer.initializeClient">initializeClient</a></td> 391 <td><a href="#DebugServer.initializeClient">initializeClient</a></td>
388 <td>Public method to initialize a freshly connected debug client.</td> 392 <td>Public method to initialize a freshly connected debug client.</td>
389 </tr> 393 </tr>
390 <tr> 394 <tr>
391 <td><a href="#DebugServer.isClientProcessUp">isClientProcessUp</a></td> 395 <td><a href="#DebugServer.isClientProcessUp">isClientProcessUp</a></td>
392 <td>Public method to check, if the debug client process is up.</td> 396 <td>Public method to check, if the debug client process is up or we are doing debugging via the eric-ide server.</td>
393 </tr> 397 </tr>
394 <tr> 398 <tr>
395 <td><a href="#DebugServer.isConnected">isConnected</a></td> 399 <td><a href="#DebugServer.isConnected">isConnected</a></td>
396 <td>Public method to test, if the debug server is connected to a backend.</td> 400 <td>Public method to test, if the debug server is connected to a backend.</td>
397 </tr> 401 </tr>
1319 <dt>Return Type:</dt> 1323 <dt>Return Type:</dt>
1320 <dd> 1324 <dd>
1321 list of str 1325 list of str
1322 </dd> 1326 </dd>
1323 </dl> 1327 </dl>
1328 <a NAME="DebugServer.getEricServerEnvironmentString" ID="DebugServer.getEricServerEnvironmentString"></a>
1329 <h4>DebugServer.getEricServerEnvironmentString</h4>
1330 <b>getEricServerEnvironmentString</b>(<i></i>)
1331 <p>
1332 Public method to get the string for an eric-ide server environment.
1333 </p>
1334
1335 <dl>
1336 <dt>Return:</dt>
1337 <dd>
1338 string for the eric-ide server environment
1339 </dd>
1340 </dl>
1341 <dl>
1342 <dt>Return Type:</dt>
1343 <dd>
1344 str
1345 </dd>
1346 </dl>
1324 <a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a> 1347 <a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a>
1325 <h4>DebugServer.getExtensions</h4> 1348 <h4>DebugServer.getExtensions</h4>
1326 <b>getExtensions</b>(<i>language</i>) 1349 <b>getExtensions</b>(<i>language</i>)
1327 <p> 1350 <p>
1328 Public slot to get the extensions associated with the given language. 1351 Public slot to get the extensions associated with the given language.
1455 </dl> 1478 </dl>
1456 <a NAME="DebugServer.isClientProcessUp" ID="DebugServer.isClientProcessUp"></a> 1479 <a NAME="DebugServer.isClientProcessUp" ID="DebugServer.isClientProcessUp"></a>
1457 <h4>DebugServer.isClientProcessUp</h4> 1480 <h4>DebugServer.isClientProcessUp</h4>
1458 <b>isClientProcessUp</b>(<i></i>) 1481 <b>isClientProcessUp</b>(<i></i>)
1459 <p> 1482 <p>
1460 Public method to check, if the debug client process is up. 1483 Public method to check, if the debug client process is up or we are
1484 doing debugging via the eric-ide server.
1461 </p> 1485 </p>
1462 1486
1463 <dl> 1487 <dl>
1464 <dt>Return:</dt> 1488 <dt>Return:</dt>
1465 <dd> 1489 <dd>
2818 Public method to process the main client exiting. 2842 Public method to process the main client exiting.
2819 </p> 2843 </p>
2820 2844
2821 <a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a> 2845 <a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a>
2822 <h4>DebugServer.startClient</h4> 2846 <h4>DebugServer.startClient</h4>
2823 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None, configOverride=None, </i>) 2847 <b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir="", configOverride=None, startRemote=None, </i>)
2824 <p> 2848 <p>
2825 Public method to start a debug client. 2849 Public method to start a debug client.
2826 </p> 2850 </p>
2827 2851
2828 <dl> 2852 <dl>
2829 2853
2830 <dt><i>unplanned</i> (bool)</dt> 2854 <dt><i>unplanned</i> (bool (optional))</dt>
2831 <dd> 2855 <dd>
2832 flag indicating that the client has died 2856 flag indicating that the client has died (defaults to True)
2833 </dd> 2857 </dd>
2834 <dt><i>clType</i> (str)</dt> 2858 <dt><i>clType</i> (str (optional))</dt>
2835 <dd> 2859 <dd>
2836 type of client to be started 2860 type of client to be started (defaults to None)
2837 </dd> 2861 </dd>
2838 <dt><i>forProject</i> (bool)</dt> 2862 <dt><i>forProject</i> (bool (optional))</dt>
2839 <dd> 2863 <dd>
2840 flag indicating a project related action 2864 flag indicating a project related action (defaults to False)
2841 </dd> 2865 </dd>
2842 <dt><i>runInConsole</i> (bool)</dt> 2866 <dt><i>runInConsole</i> (bool (optional))</dt>
2843 <dd> 2867 <dd>
2844 flag indicating to start the debugger in a 2868 flag indicating to start the debugger in a
2845 console window 2869 console window (defaults to False)
2846 </dd> 2870 </dd>
2847 <dt><i>venvName</i> (str)</dt> 2871 <dt><i>venvName</i> (str (optional))</dt>
2848 <dd> 2872 <dd>
2849 name of the virtual environment to be used 2873 name of the virtual environment to be used (defaults to "")
2850 </dd> 2874 </dd>
2851 <dt><i>workingDir</i> (str)</dt> 2875 <dt><i>workingDir</i> (str (optional))</dt>
2852 <dd> 2876 <dd>
2853 directory to start the debugger client in 2877 directory to start the debugger client in (defaults to "")
2854 </dd> 2878 </dd>
2855 <dt><i>configOverride</i> (dict)</dt> 2879 <dt><i>configOverride</i> (dict (optional))</dt>
2856 <dd> 2880 <dd>
2857 dictionary containing the global config override 2881 dictionary containing the global config override data
2858 data 2882 (defaults to None)
2883 </dd>
2884 <dt><i>startRemote</i> (bool (optional))</dt>
2885 <dd>
2886 flag indicating to start the client via an eric-ide server
2887 (defaults to None)
2859 </dd> 2888 </dd>
2860 </dl> 2889 </dl>
2861 <a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a> 2890 <a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a>
2862 <h4>DebugServer.unregisterDebuggerInterface</h4> 2891 <h4>DebugServer.unregisterDebuggerInterface</h4>
2863 <b>unregisterDebuggerInterface</b>(<i>interfaceName</i>) 2892 <b>unregisterDebuggerInterface</b>(<i>interfaceName</i>)

eric ide

mercurial