group__TelnetConsole.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  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 Console</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 Console<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:ga4624d4df8593ca87e8b519a67f75f951"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__TelnetConsole.html#ga4624d4df8593ca87e8b519a67f75f951">telnetSetParameters</a> (int port, string consolePass, string listenPass)</td></tr>
  49. <tr class="separator:ga4624d4df8593ca87e8b519a67f75f951"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. </table>
  51. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  52. <h2 class="groupheader">Function Documentation</h2>
  53. <a class="anchor" id="ga4624d4df8593ca87e8b519a67f75f951"></a>
  54. <div class="memitem">
  55. <div class="memproto">
  56. <table class="memname">
  57. <tr>
  58. <td class="memname">void telnetSetParameters </td>
  59. <td>(</td>
  60. <td class="paramtype">int&#160;</td>
  61. <td class="paramname"><em>port</em>, </td>
  62. </tr>
  63. <tr>
  64. <td class="paramkey"></td>
  65. <td></td>
  66. <td class="paramtype">string&#160;</td>
  67. <td class="paramname"><em>consolePass</em>, </td>
  68. </tr>
  69. <tr>
  70. <td class="paramkey"></td>
  71. <td></td>
  72. <td class="paramtype">string&#160;</td>
  73. <td class="paramname"><em>listenPass</em>&#160;</td>
  74. </tr>
  75. <tr>
  76. <td></td>
  77. <td>)</td>
  78. <td></td><td></td>
  79. </tr>
  80. </table>
  81. </div><div class="memdoc">
  82. <p>Initialize and open the telnet console. </p><dl class="params"><dt>Parameters</dt><dd>
  83. <table class="params">
  84. <tr><td class="paramname">port</td><td>Port to listen on for console connections (0 will shut down listening). </td></tr>
  85. <tr><td class="paramname">consolePass</td><td>Password for read/write access to console. </td></tr>
  86. <tr><td class="paramname">listenPass</td><td>Password for read access to console. </td></tr>
  87. <tr><td class="paramname">remoteEcho</td><td>[optional] Enable echoing back to the client, off by default. </td></tr>
  88. </table>
  89. </dd>
  90. </dl>
  91. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  92. </div>
  93. </div>
  94. </div><!-- contents -->
  95. <!-- start footer part -->
  96. <hr class="footer"/><address class="footer"><small>
  97. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  98. <img class="footer" src="doxygen.png" alt="doxygen"/>
  99. </a> 1.8.10
  100. </small></address>
  101. </body>
  102. </html>