group__TelnetDebuggerFunctions.html 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  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.10"/>
  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 id="projectalign" 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.10 -->
  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="modules.html"><span>Modules</span></a></li>
  34. <li><a href="annotated.html"><span>Classes</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">Telnet Debugger<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <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>
  49. <tr class="separator:ga2b6a386fc75582e34714ebe612ef04c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <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>
  51. <tr class="separator:ga2449ab1a8639f7d8b4e473a78362e99c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <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>
  53. <tr class="separator:ga94a1f3d563094370d02538acabca3412"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. </table>
  55. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  56. <h2 class="groupheader">Function Documentation</h2>
  57. <a class="anchor" id="ga2b6a386fc75582e34714ebe612ef04c7"></a>
  58. <div class="memitem">
  59. <div class="memproto">
  60. <table class="memname">
  61. <tr>
  62. <td class="memname">void dbgDisconnect </td>
  63. <td>(</td>
  64. <td class="paramname"></td><td>)</td>
  65. <td></td>
  66. </tr>
  67. </table>
  68. </div><div class="memdoc">
  69. <p>Forcibly disconnects any attached script debugging client. </p><dl class="section return"><dt>Returns</dt><dd>No Return Value </dd></dl>
  70. </div>
  71. </div>
  72. <a class="anchor" id="ga2449ab1a8639f7d8b4e473a78362e99c"></a>
  73. <div class="memitem">
  74. <div class="memproto">
  75. <table class="memname">
  76. <tr>
  77. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> dbgIsConnected </td>
  78. <td>(</td>
  79. <td class="paramname"></td><td>)</td>
  80. <td></td>
  81. </tr>
  82. </table>
  83. </div><div class="memdoc">
  84. <dl class="section return"><dt>Returns</dt><dd>Returns true if a script debugging client is connected else return false. </dd></dl>
  85. </div>
  86. </div>
  87. <a class="anchor" id="ga94a1f3d563094370d02538acabca3412"></a>
  88. <div class="memitem">
  89. <div class="memproto">
  90. <table class="memname">
  91. <tr>
  92. <td class="memname">void dbgSetParameters </td>
  93. <td>(</td>
  94. <td class="paramtype">int&#160;</td>
  95. <td class="paramname"><em>port</em>, </td>
  96. </tr>
  97. <tr>
  98. <td class="paramkey"></td>
  99. <td></td>
  100. <td class="paramtype">string&#160;</td>
  101. <td class="paramname"><em>password</em>, </td>
  102. </tr>
  103. <tr>
  104. <td class="paramkey"></td>
  105. <td></td>
  106. <td class="paramtype">bool&#160;</td>
  107. <td class="paramname"><em>waitForClient</em>&#160;</td>
  108. </tr>
  109. <tr>
  110. <td></td>
  111. <td>)</td>
  112. <td></td><td></td>
  113. </tr>
  114. </table>
  115. </div><div class="memdoc">
  116. <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>
  117. <table class="params">
  118. <tr><td class="paramname">port</td><td>The IP port to set the password on. </td></tr>
  119. <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>
  120. </table>
  121. </dd>
  122. </dl>
  123. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  124. </div>
  125. </div>
  126. </div><!-- contents -->
  127. <!-- start footer part -->
  128. <hr class="footer"/><address class="footer"><small>
  129. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  130. <img class="footer" src="doxygen.png" alt="doxygen"/>
  131. </a> 1.8.10
  132. </small></address>
  133. </body>
  134. </html>