Init
This commit is contained in:
16
Help/Doxygen/html/dc/dbe/class_s_l_net_1_1_console_server.js
Normal file
16
Help/Doxygen/html/dc/dbe/class_s_l_net_1_1_console_server.js
Normal file
@ -0,0 +1,16 @@
|
||||
var class_s_l_net_1_1_console_server =
|
||||
[
|
||||
[ "ConsoleServer", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a35ea189e5440de9adf7718e884a709b1", null ],
|
||||
[ "~ConsoleServer", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#abfb752364018ae5b16eefb7ae468084d", null ],
|
||||
[ "AddCommandParser", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#ab8693b4ab30edf0d588b79028f433777", null ],
|
||||
[ "ListParsers", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#aa091718623c3ccfb07c4e637168f5213", null ],
|
||||
[ "RemoveCommandParser", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a852036c6df3cd64aa348802812c429ea", null ],
|
||||
[ "SetPrompt", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a096ef940c7b82f3f18516f77cb476fa3", null ],
|
||||
[ "SetTransportProvider", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a99127cc5c9dcb7b71ba3c5c5a207eb2d", null ],
|
||||
[ "ShowPrompt", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a4fa1c29255db032b4d2e8858994ee1da", null ],
|
||||
[ "Update", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#aa1252e0250a4b4c46970f10d80badcfd", null ],
|
||||
[ "commandParserList", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a927689d808bc1c59366adf149ac85330", null ],
|
||||
[ "password", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#ab36cf7b6cf84726a402ebb09e618798f", null ],
|
||||
[ "prompt", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a10c06f10673dea6832ff7a57aef873c3", null ],
|
||||
[ "transport", "dc/dbe/class_s_l_net_1_1_console_server.xhtml#a4c0d97b8baa92178847fa971a9a337a0", null ]
|
||||
];
|
||||
478
Help/Doxygen/html/dc/dbe/class_s_l_net_1_1_console_server.xhtml
Normal file
478
Help/Doxygen/html/dc/dbe/class_s_l_net_1_1_console_server.xhtml
Normal file
@ -0,0 +1,478 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>SLikeNet: SLNet::ConsoleServer 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="../../navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../resize.js"></script>
|
||||
<script type="text/javascript" src="../../navtree.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
</script>
|
||||
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../search/search.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||||
</script>
|
||||
<link href="../../doxygen.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 style="height: 56px;">
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">SLikeNet
|
||||
 <span id="projectnumber">0.1.3</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
||||
</script>
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="../../index.xhtml"><span>Main Page</span></a></li>
|
||||
<li><a href="../../pages.xhtml"><span>Related Pages</span></a></li>
|
||||
<li><a href="../../modules.xhtml"><span>Modules</span></a></li>
|
||||
<li><a href="../../namespaces.xhtml"><span>Namespaces</span></a></li>
|
||||
<li class="current"><a href="../../annotated.xhtml"><span>Classes</span></a></li>
|
||||
<li><a href="../../files.xhtml"><span>Files</span></a></li>
|
||||
<li>
|
||||
<div id="MSearchBox" class="MSearchBoxInactive">
|
||||
<span class="left">
|
||||
<img id="MSearchSelect" src="../../search/mag_sel.png"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
alt=""/>
|
||||
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||||
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||||
onblur="searchBox.OnSearchFieldFocus(false)"
|
||||
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||||
</span><span class="right">
|
||||
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
|
||||
</span>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="../../annotated.xhtml"><span>Class List</span></a></li>
|
||||
<li><a href="../../classes.xhtml"><span>Class Index</span></a></li>
|
||||
<li><a href="../../inherits.xhtml"><span>Class Hierarchy</span></a></li>
|
||||
<li><a href="../../functions.xhtml"><span>Class Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function(){initNavTree('dc/dbe/class_s_l_net_1_1_console_server.xhtml','../../');});
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pro-methods">Protected Member Functions</a> |
|
||||
<a href="#pro-attribs">Protected Attributes</a> |
|
||||
<a href="../../d2/d66/class_s_l_net_1_1_console_server-members.xhtml">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">SLNet::ConsoleServer Class Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>The main entry point for the server portion of your remote console application support.
|
||||
<a href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">slikenet/ConsoleServer.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a35ea189e5440de9adf7718e884a709b1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a35ea189e5440de9adf7718e884a709b1">ConsoleServer</a> ()</td></tr>
|
||||
<tr class="separator:a35ea189e5440de9adf7718e884a709b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abfb752364018ae5b16eefb7ae468084d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#abfb752364018ae5b16eefb7ae468084d">~ConsoleServer</a> ()</td></tr>
|
||||
<tr class="separator:abfb752364018ae5b16eefb7ae468084d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a99127cc5c9dcb7b71ba3c5c5a207eb2d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a99127cc5c9dcb7b71ba3c5c5a207eb2d">SetTransportProvider</a> (<a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml">TransportInterface</a> *transportInterface, unsigned short port)</td></tr>
|
||||
<tr class="memdesc:a99127cc5c9dcb7b71ba3c5c5a207eb2d"><td class="mdescLeft"> </td><td class="mdescRight">Call this with a derivation of <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> so that the console server can send and receive commands. <a href="#a99127cc5c9dcb7b71ba3c5c5a207eb2d"></a><br/></td></tr>
|
||||
<tr class="separator:a99127cc5c9dcb7b71ba3c5c5a207eb2d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab8693b4ab30edf0d588b79028f433777"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#ab8693b4ab30edf0d588b79028f433777">AddCommandParser</a> (<a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml">CommandParserInterface</a> *commandParserInterface)</td></tr>
|
||||
<tr class="memdesc:ab8693b4ab30edf0d588b79028f433777"><td class="mdescLeft"> </td><td class="mdescRight">Add an implementation of <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml" title="The interface used by command parsers.">CommandParserInterface</a> to the list of command parsers. <a href="#ab8693b4ab30edf0d588b79028f433777"></a><br/></td></tr>
|
||||
<tr class="separator:ab8693b4ab30edf0d588b79028f433777"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a852036c6df3cd64aa348802812c429ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a852036c6df3cd64aa348802812c429ea">RemoveCommandParser</a> (<a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml">CommandParserInterface</a> *commandParserInterface)</td></tr>
|
||||
<tr class="memdesc:a852036c6df3cd64aa348802812c429ea"><td class="mdescLeft"> </td><td class="mdescRight">Remove an implementation of <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml" title="The interface used by command parsers.">CommandParserInterface</a> previously added with <a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#ab8693b4ab30edf0d588b79028f433777" title="Add an implementation of CommandParserInterface to the list of command parsers.">AddCommandParser()</a>. <a href="#a852036c6df3cd64aa348802812c429ea"></a><br/></td></tr>
|
||||
<tr class="separator:a852036c6df3cd64aa348802812c429ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa1252e0250a4b4c46970f10d80badcfd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#aa1252e0250a4b4c46970f10d80badcfd">Update</a> (void)</td></tr>
|
||||
<tr class="memdesc:aa1252e0250a4b4c46970f10d80badcfd"><td class="mdescLeft"> </td><td class="mdescRight">Call update to read packet sent from your <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a>. You should do this fairly frequently. <a href="#aa1252e0250a4b4c46970f10d80badcfd"></a><br/></td></tr>
|
||||
<tr class="separator:aa1252e0250a4b4c46970f10d80badcfd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a096ef940c7b82f3f18516f77cb476fa3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a096ef940c7b82f3f18516f77cb476fa3">SetPrompt</a> (const char *_prompt)</td></tr>
|
||||
<tr class="memdesc:a096ef940c7b82f3f18516f77cb476fa3"><td class="mdescLeft"> </td><td class="mdescRight">Sets a prompt to show when waiting for user input. <a href="#a096ef940c7b82f3f18516f77cb476fa3"></a><br/></td></tr>
|
||||
<tr class="separator:a096ef940c7b82f3f18516f77cb476fa3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
||||
Protected Member Functions</h2></td></tr>
|
||||
<tr class="memitem:aa091718623c3ccfb07c4e637168f5213"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#aa091718623c3ccfb07c4e637168f5213">ListParsers</a> (<a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a> systemAddress)</td></tr>
|
||||
<tr class="separator:aa091718623c3ccfb07c4e637168f5213"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4fa1c29255db032b4d2e8858994ee1da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a4fa1c29255db032b4d2e8858994ee1da">ShowPrompt</a> (<a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a> systemAddress)</td></tr>
|
||||
<tr class="separator:a4fa1c29255db032b4d2e8858994ee1da"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
||||
Protected Attributes</h2></td></tr>
|
||||
<tr class="memitem:a4c0d97b8baa92178847fa971a9a337a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml">TransportInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a4c0d97b8baa92178847fa971a9a337a0">transport</a></td></tr>
|
||||
<tr class="separator:a4c0d97b8baa92178847fa971a9a337a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a927689d808bc1c59366adf149ac85330"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a><br class="typebreak"/>
|
||||
< <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml">CommandParserInterface</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a927689d808bc1c59366adf149ac85330">commandParserList</a></td></tr>
|
||||
<tr class="separator:a927689d808bc1c59366adf149ac85330"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab36cf7b6cf84726a402ebb09e618798f"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#ab36cf7b6cf84726a402ebb09e618798f">password</a> [256]</td></tr>
|
||||
<tr class="separator:ab36cf7b6cf84726a402ebb09e618798f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a10c06f10673dea6832ff7a57aef873c3"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#a10c06f10673dea6832ff7a57aef873c3">prompt</a></td></tr>
|
||||
<tr class="separator:a10c06f10673dea6832ff7a57aef873c3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>The main entry point for the server portion of your remote console application support. </p>
|
||||
<p><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml" title="The main entry point for the server portion of your remote console application support.">ConsoleServer</a> takes one <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> and one or more <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml" title="The interface used by command parsers.">CommandParserInterface</a> (s) The <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> will be used to send data between the server and the client. The connecting client must support the protocol used by your derivation of <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> . <a class="el" href="../../d3/d41/class_s_l_net_1_1_telnet_transport.xhtml" title="Use TelnetTransport to easily allow windows telnet to connect to your ConsoleServer.">TelnetTransport</a> and RakNetTransport are two such derivations . When a command is sent by a remote console, it will be processed by your implementations of <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml" title="The interface used by command parsers.">CommandParserInterface</a> </p>
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml#l00044">44</a> of file <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">ConsoleServer.h</a>.</p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a35ea189e5440de9adf7718e884a709b1"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">SLNet::ConsoleServer::ConsoleServer </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="abfb752364018ae5b16eefb7ae468084d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">SLNet::ConsoleServer::~ConsoleServer </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a class="anchor" id="ab8693b4ab30edf0d588b79028f433777"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::AddCommandParser </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml">CommandParserInterface</a> * </td>
|
||||
<td class="paramname"><em>commandParserInterface</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Add an implementation of <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml" title="The interface used by command parsers.">CommandParserInterface</a> to the list of command parsers. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">commandParserInterface</td><td>The command parser referred to </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aa091718623c3ccfb07c4e637168f5213"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::ListParsers </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a> </td>
|
||||
<td class="paramname"><em>systemAddress</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a852036c6df3cd64aa348802812c429ea"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::RemoveCommandParser </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml">CommandParserInterface</a> * </td>
|
||||
<td class="paramname"><em>commandParserInterface</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Remove an implementation of <a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml" title="The interface used by command parsers.">CommandParserInterface</a> previously added with <a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml#ab8693b4ab30edf0d588b79028f433777" title="Add an implementation of CommandParserInterface to the list of command parsers.">AddCommandParser()</a>. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">commandParserInterface</td><td>The command parser referred to </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a096ef940c7b82f3f18516f77cb476fa3"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::SetPrompt </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const char * </td>
|
||||
<td class="paramname"><em>_prompt</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Sets a prompt to show when waiting for user input. </p>
|
||||
<p>Pass an empty string to clear the prompt Defaults to no prompt </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">_prompt</td><td>Null-terminated string of the prompt to use. If you want a newline, be sure to use /r/n </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a99127cc5c9dcb7b71ba3c5c5a207eb2d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::SetTransportProvider </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml">TransportInterface</a> * </td>
|
||||
<td class="paramname"><em>transportInterface</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">unsigned short </td>
|
||||
<td class="paramname"><em>port</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Call this with a derivation of <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a> so that the console server can send and receive commands. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">transportInterface</td><td>Your interface to use. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">port</td><td>The port to host on. Telnet uses port 23 by default. RakNet can use whatever you want. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a4fa1c29255db032b4d2e8858994ee1da"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::ShowPrompt </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d8/dbe/struct_s_l_net_1_1_system_address.xhtml">SystemAddress</a> </td>
|
||||
<td class="paramname"><em>systemAddress</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="aa1252e0250a4b4c46970f10d80badcfd"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void SLNet::ConsoleServer::Update </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Call update to read packet sent from your <a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml" title="Defines an interface that is used to send and receive null-terminated strings.">TransportInterface</a>. You should do this fairly frequently. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Data Documentation</h2>
|
||||
<a class="anchor" id="a927689d808bc1c59366adf149ac85330"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="../../d4/d78/class_data_structures_1_1_list.xhtml">DataStructures::List</a><<a class="el" href="../../d5/d9a/class_s_l_net_1_1_command_parser_interface.xhtml">CommandParserInterface</a> *> SLNet::ConsoleServer::commandParserList</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml#l00080">80</a> of file <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">ConsoleServer.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ab36cf7b6cf84726a402ebb09e618798f"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">char* SLNet::ConsoleServer::password[256]</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml#l00081">81</a> of file <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">ConsoleServer.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a10c06f10673dea6832ff7a57aef873c3"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">char* SLNet::ConsoleServer::prompt</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml#l00082">82</a> of file <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">ConsoleServer.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a4c0d97b8baa92178847fa971a9a337a0"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="../../d0/d4e/class_s_l_net_1_1_transport_interface.xhtml">TransportInterface</a>* SLNet::ConsoleServer::transport</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Definition at line <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml#l00079">79</a> of file <a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">ConsoleServer.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li>Source/include/slikenet/<a class="el" href="../../df/d1c/_console_server_8h_source.xhtml">ConsoleServer.h</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="../../dd/d30/namespace_s_l_net.xhtml">SLNet</a></li><li class="navelem"><a class="el" href="../../dc/dbe/class_s_l_net_1_1_console_server.xhtml">ConsoleServer</a></li>
|
||||
<li class="footer">Generated on Wed Aug 14 2019 22:09:49 for SLikeNet by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.2 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user