group__TelnetDebuggerFunctions.html 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: Telnet Debugger</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">Telnet Debugger<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:ga2b6a386fc75582e34714ebe612ef04c7" id="r_ga2b6a386fc75582e34714ebe612ef04c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TelnetDebuggerFunctions.html#ga2b6a386fc75582e34714ebe612ef04c7">dbgDisconnect</a> ()</td></tr>
  52. <tr class="separator:ga2b6a386fc75582e34714ebe612ef04c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga2449ab1a8639f7d8b4e473a78362e99c" id="r_ga2449ab1a8639f7d8b4e473a78362e99c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TelnetDebuggerFunctions.html#ga2449ab1a8639f7d8b4e473a78362e99c">dbgIsConnected</a> ()</td></tr>
  54. <tr class="separator:ga2449ab1a8639f7d8b4e473a78362e99c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:ga94a1f3d563094370d02538acabca3412" id="r_ga94a1f3d563094370d02538acabca3412"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TelnetDebuggerFunctions.html#ga94a1f3d563094370d02538acabca3412">dbgSetParameters</a> (int port, string password, bool waitForClient)</td></tr>
  56. <tr class="separator:ga94a1f3d563094370d02538acabca3412"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. </table>
  58. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  59. <h2 class="groupheader">Function Documentation</h2>
  60. <a id="ga2b6a386fc75582e34714ebe612ef04c7" name="ga2b6a386fc75582e34714ebe612ef04c7"></a>
  61. <h2 class="memtitle"><span class="permalink"><a href="#ga2b6a386fc75582e34714ebe612ef04c7">&#9670;&#160;</a></span>dbgDisconnect()</h2>
  62. <div class="memitem">
  63. <div class="memproto">
  64. <table class="memname">
  65. <tr>
  66. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> dbgDisconnect </td>
  67. <td>(</td>
  68. <td class="paramname"></td><td>)</td>
  69. <td></td>
  70. </tr>
  71. </table>
  72. </div><div class="memdoc">
  73. <p>Forcibly disconnects any attached script debugging client. </p><dl class="section return"><dt>Returns</dt><dd>No Return Value </dd></dl>
  74. </div>
  75. </div>
  76. <a id="ga2449ab1a8639f7d8b4e473a78362e99c" name="ga2449ab1a8639f7d8b4e473a78362e99c"></a>
  77. <h2 class="memtitle"><span class="permalink"><a href="#ga2449ab1a8639f7d8b4e473a78362e99c">&#9670;&#160;</a></span>dbgIsConnected()</h2>
  78. <div class="memitem">
  79. <div class="memproto">
  80. <table class="memname">
  81. <tr>
  82. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> dbgIsConnected </td>
  83. <td>(</td>
  84. <td class="paramname"></td><td>)</td>
  85. <td></td>
  86. </tr>
  87. </table>
  88. </div><div class="memdoc">
  89. <dl class="section return"><dt>Returns</dt><dd>Returns true if a script debugging client is connected else return false. </dd></dl>
  90. </div>
  91. </div>
  92. <a id="ga94a1f3d563094370d02538acabca3412" name="ga94a1f3d563094370d02538acabca3412"></a>
  93. <h2 class="memtitle"><span class="permalink"><a href="#ga94a1f3d563094370d02538acabca3412">&#9670;&#160;</a></span>dbgSetParameters()</h2>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> dbgSetParameters </td>
  99. <td>(</td>
  100. <td class="paramtype">int&#160;</td>
  101. <td class="paramname"><em>port</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">string&#160;</td>
  107. <td class="paramname"><em>password</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">bool&#160;</td>
  113. <td class="paramname"><em>waitForClient</em>&#160;</td>
  114. </tr>
  115. <tr>
  116. <td></td>
  117. <td>)</td>
  118. <td></td><td></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>Open a debug server port on the specified port, requiring the specified password, and optionally waiting for the debug client to connect. </p><dl class="params"><dt>Parameters</dt><dd>
  123. <table class="params">
  124. <tr><td class="paramname">port</td><td>The IP port to set the password on. </td></tr>
  125. <tr><td class="paramname">password</td><td>The password for this port. Set this to a NULL string to clear the password for the port. </td></tr>
  126. </table>
  127. </dd>
  128. </dl>
  129. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  130. </div>
  131. </div>
  132. </div><!-- contents -->
  133. <!-- start footer part -->
  134. <hr class="footer"/><address class="footer"><small>
  135. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  136. </small></address>
  137. </body>
  138. </html>