TorqueEngine
/
Torque2D
réplica de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: TelnetConsole Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_telnet_console-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">TelnetConsole Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;telnetConsole.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2e9c5136d19b1a95fc427e0852deab5c" id="r_a2e9c5136d19b1a95fc427e0852deab5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_telnet_console.html#a2e9c5136d19b1a95fc427e0852deab5c">process</a> ()</td></tr>
<tr class="separator:a2e9c5136d19b1a95fc427e0852deab5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f4cbca7ec56fde92a39e4f2d1b64ceb" id="r_a3f4cbca7ec56fde92a39e4f2d1b64ceb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_telnet_console.html#a3f4cbca7ec56fde92a39e4f2d1b64ceb">setTelnetParameters</a> (S32 port, const char *telnetPassword, const char *listenPassword, bool remoteEcho=false)</td></tr>
<tr class="separator:a3f4cbca7ec56fde92a39e4f2d1b64ceb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8fef7b79b715d07e9415e8db29ce85b" id="r_ad8fef7b79b715d07e9415e8db29ce85b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_telnet_console.html#ad8fef7b79b715d07e9415e8db29ce85b">processConsoleLine</a> (const char *line)</td></tr>
<tr class="separator:ad8fef7b79b715d07e9415e8db29ce85b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae2ee59f7cc16ee42559c87e81c433039" id="r_ae2ee59f7cc16ee42559c87e81c433039"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_telnet_console.html#ae2ee59f7cc16ee42559c87e81c433039">create</a> ()</td></tr>
<tr class="memdesc:ae2ee59f7cc16ee42559c87e81c433039"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the telnet console.  <br /></td></tr>
<tr class="separator:ae2ee59f7cc16ee42559c87e81c433039"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a80b6032f86a56bec74609034b3246f" id="r_a3a80b6032f86a56bec74609034b3246f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_telnet_console.html#a3a80b6032f86a56bec74609034b3246f">destroy</a> ()</td></tr>
<tr class="memdesc:a3a80b6032f86a56bec74609034b3246f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shut down the telnet console.  <br /></td></tr>
<tr class="separator:a3a80b6032f86a56bec74609034b3246f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Telnet admin console.</p>
<p><a class="el" href="namespace_torque.html">Torque</a> supports remote access to its console. This is most useful when running a dedicated server, as you can remotely administer the game (for instance, kicking people). In the context of a MMORPG, this sort of functionality would be useful for managing a server.</p>
<p>There are a number of products for Tribes2 which allow remote administration via a nice GUI.</p>
<h1><a class="anchor" id="telnetconsole_use"></a>
Using the Telnet Console</h1>
<p>The <a class="el" href="class_telnet_console.html">TelnetConsole</a> is designed to be used globally, so you don't instantiate it like a normal class. Instead, you allow it to manage itself:</p>
<div class="fragment"><div class="line"><span class="comment">// How to initialize the TelnetConsole.</span></div>
<div class="line"><a class="code hl_function" href="class_telnet_console.html#ae2ee59f7cc16ee42559c87e81c433039">TelnetConsole::create</a>();</div>
<div class="line"> </div>
<div class="line"><span class="comment">// How to shut down the TelnetConsole.</span></div>
<div class="line"><a class="code hl_function" href="class_telnet_console.html#a3a80b6032f86a56bec74609034b3246f">TelnetConsole::destroy</a>();</div>
<div class="ttc" id="aclass_telnet_console_html_a3a80b6032f86a56bec74609034b3246f"><div class="ttname"><a href="class_telnet_console.html#a3a80b6032f86a56bec74609034b3246f">TelnetConsole::destroy</a></div><div class="ttdeci">static void destroy()</div><div class="ttdoc">Shut down the telnet console.</div><div class="ttdef"><b>Definition</b> telnetConsole.cc:37</div></div>
<div class="ttc" id="aclass_telnet_console_html_ae2ee59f7cc16ee42559c87e81c433039"><div class="ttname"><a href="class_telnet_console.html#ae2ee59f7cc16ee42559c87e81c433039">TelnetConsole::create</a></div><div class="ttdeci">static void create()</div><div class="ttdoc">Initialize the telnet console.</div><div class="ttdef"><b>Definition</b> telnetConsole.cc:32</div></div>
</div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae2ee59f7cc16ee42559c87e81c433039" name="ae2ee59f7cc16ee42559c87e81c433039"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2ee59f7cc16ee42559c87e81c433039">&#9670;&#160;</a></span>create()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void create </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initialize the telnet console. </p>

</div>
</div>
<a id="a3a80b6032f86a56bec74609034b3246f" name="a3a80b6032f86a56bec74609034b3246f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a80b6032f86a56bec74609034b3246f">&#9670;&#160;</a></span>destroy()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void destroy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Shut down the telnet console. </p>

</div>
</div>
<a id="a2e9c5136d19b1a95fc427e0852deab5c" name="a2e9c5136d19b1a95fc427e0852deab5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e9c5136d19b1a95fc427e0852deab5c">&#9670;&#160;</a></span>process()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void process </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Called by the main loop to let the console process commands and connections. </p>

</div>
</div>
<a id="ad8fef7b79b715d07e9415e8db29ce85b" name="ad8fef7b79b715d07e9415e8db29ce85b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8fef7b79b715d07e9415e8db29ce85b">&#9670;&#160;</a></span>processConsoleLine()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void processConsoleLine </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>line</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Callback to handle a line from the console.</p>
<dl class="section note"><dt>Note</dt><dd>This is used internally by the class; you shouldn't need to call it.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_con.html#a648038e7c75ddf17ab4ca01ffa347d27">Con::addConsumer()</a> </dd></dl>

</div>
</div>
<a id="a3f4cbca7ec56fde92a39e4f2d1b64ceb" name="a3f4cbca7ec56fde92a39e4f2d1b64ceb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f4cbca7ec56fde92a39e4f2d1b64ceb">&#9670;&#160;</a></span>setTelnetParameters()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setTelnetParameters </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>telnetPassword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>listenPassword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>remoteEcho</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Configure the parameter for the telnet console.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">port</td><td>Port on which to listen for connections. </td></tr>
    <tr><td class="paramname">telnetPassword</td><td>Password for full access to the console. </td></tr>
    <tr><td class="paramname">listenPassword</td><td>Password for read-only access to the console. </td></tr>
    <tr><td class="paramname">remoteEcho</td><td>Enable/disable echoing input back to the client </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>network/<b>telnetConsole.h</b></li>
<li>network/<b>telnetConsole.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>