group__TelnetDebuggerFunctions.html 6.1 KB

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