ServerCore/html/classcore_1_1ConsoleSession.html

339 lines
40 KiB
HTML

<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: core::ConsoleSession 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" />
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>core</b></li><li class="navelem"><a class="el" href="classcore_1_1ConsoleSession.html">ConsoleSession</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classcore_1_1ConsoleSession-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">core::ConsoleSession Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="ConsoleSession_8h_source.html">ConsoleSession.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for core::ConsoleSession:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1ConsoleSession__inherit__graph.png" border="0" usemap="#core_1_1ConsoleSession_inherit__map" alt="Inheritance graph"/></div>
<map name="core_1_1ConsoleSession_inherit__map" id="core_1_1ConsoleSession_inherit__map">
<area shape="rect" id="node2" href="classcore_1_1TerminalSession.html" title="core::TerminalSession" alt="" coords="5,379,157,405"/>
<area shape="rect" id="node3" href="classcore_1_1TLSSession.html" title="core::TLSSession" alt="" coords="18,304,145,331"/>
<area shape="rect" id="node4" href="classcore_1_1TCPSession.html" title="core::TCPSession" alt="" coords="17,229,146,256"/>
<area shape="rect" id="node5" href="classcore_1_1TCPSocket.html" title="core::TCPSocket" alt="" coords="20,155,143,181"/>
<area shape="rect" id="node6" href="classcore_1_1Socket.html" title="core::Socket" alt="" coords="33,80,129,107"/>
<area shape="rect" id="node7" href="classcore_1_1Object.html" title="core::Object" alt="" coords="35,5,128,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for core::ConsoleSession:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1ConsoleSession__coll__graph.png" border="0" usemap="#core_1_1ConsoleSession_coll__map" alt="Collaboration graph"/></div>
<map name="core_1_1ConsoleSession_coll__map" id="core_1_1ConsoleSession_coll__map">
<area shape="rect" id="node2" href="classcore_1_1TerminalSession.html" title="core::TerminalSession" alt="" coords="231,719,383,745"/>
<area shape="rect" id="node3" href="classcore_1_1TLSSession.html" title="core::TLSSession" alt="" coords="243,643,370,669"/>
<area shape="rect" id="node4" href="classcore_1_1TCPSession.html" title="core::TCPSession" alt="" coords="242,567,371,593"/>
<area shape="rect" id="node5" href="classcore_1_1TCPSocket.html" title="core::TCPSocket" alt="" coords="104,373,227,400"/>
<area shape="rect" id="node11" href="classcore_1_1TCPServer.html" title="core::TCPServer" alt="" coords="247,477,367,504"/>
<area shape="rect" id="node6" href="classcore_1_1Socket.html" title="core::Socket" alt="" coords="5,284,101,311"/>
<area shape="rect" id="node7" href="classcore_1_1Object.html" title="core::Object" alt="" coords="89,5,183,32"/>
<area shape="rect" id="node9" href="classcore_1_1Command.html" title="core::Command" alt="" coords="241,81,356,108"/>
<area shape="rect" id="node10" href="classcore_1_1IPAddress.html" title="core::IPAddress" alt="" coords="78,132,194,159"/>
<area shape="rect" id="node8" href="classcore_1_1EPoll.html" title="core::EPoll" alt="" coords="174,183,261,209"/>
<area shape="rect" id="node12" href="classcore_1_1CommandList.html" title="core::CommandList" alt="" coords="311,233,447,260"/>
<area shape="rect" id="node13" href="classcore_1_1IPAddressList.html" title="core::IPAddressList" alt="" coords="379,373,517,400"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:ae735e9739fb4cfd2ef983cc56f9982c7"><td class="memItemLeft" align="right" valign="top"><a id="ae735e9739fb4cfd2ef983cc56f9982c7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ConsoleSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &amp;server)</td></tr>
<tr class="separator:ae735e9739fb4cfd2ef983cc56f9982c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e6b56503966f1cae5bdff8b3814e2b9"><td class="memItemLeft" align="right" valign="top"><a id="a6e6b56503966f1cae5bdff8b3814e2b9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeLog</b> (std::string data)</td></tr>
<tr class="separator:a6e6b56503966f1cae5bdff8b3814e2b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcore_1_1TerminalSession"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcore_1_1TerminalSession')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcore_1_1TerminalSession.html">core::TerminalSession</a></td></tr>
<tr class="memitem:a6773b1897d2e417ab573b28fa127230c inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a6773b1897d2e417ab573b28fa127230c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TerminalSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &amp;server)</td></tr>
<tr class="separator:a6773b1897d2e417ab573b28fa127230c inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0df0106164a7f213acf2e814e725c576 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a0df0106164a7f213acf2e814e725c576"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getLines</b> ()</td></tr>
<tr class="separator:a0df0106164a7f213acf2e814e725c576 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42bb06857891220a831da04248233935 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a42bb06857891220a831da04248233935"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="separator:a42bb06857891220a831da04248233935 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa660768eed03b0b996a749e8a146446c inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="aa660768eed03b0b996a749e8a146446c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clearEOL</b> ()</td></tr>
<tr class="separator:aa660768eed03b0b996a749e8a146446c inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9939cbe36c08e1a0b8413a96ca251fa inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="aa9939cbe36c08e1a0b8413a96ca251fa"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setCursorLocation</b> (int x, int y)</td></tr>
<tr class="separator:aa9939cbe36c08e1a0b8413a96ca251fa inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb104a3743f52c8237afc25c9abd3815 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="abb104a3743f52c8237afc25c9abd3815"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setColor</b> (int color)</td></tr>
<tr class="separator:abb104a3743f52c8237afc25c9abd3815 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96c909e28a87f2e5b64fe2ca7ab79ca7 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a96c909e28a87f2e5b64fe2ca7ab79ca7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBackColor</b> (int color)</td></tr>
<tr class="separator:a96c909e28a87f2e5b64fe2ca7ab79ca7 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a930de98aea34eca4723a1efbc0272223 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a930de98aea34eca4723a1efbc0272223"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>saveCursor</b> ()</td></tr>
<tr class="separator:a930de98aea34eca4723a1efbc0272223 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc89dc99e1b104bee7717b0cda2f9b37 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="afc89dc99e1b104bee7717b0cda2f9b37"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>restoreCursor</b> ()</td></tr>
<tr class="separator:afc89dc99e1b104bee7717b0cda2f9b37 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21f8ec433bcb4c7f55807cdcbc929134 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a21f8ec433bcb4c7f55807cdcbc929134"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>NextLine</b> (int lines)</td></tr>
<tr class="separator:a21f8ec433bcb4c7f55807cdcbc929134 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea2f243e65074cb174ddf8844c9126ff inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="aea2f243e65074cb174ddf8844c9126ff"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>PreviousLine</b> (int lines)</td></tr>
<tr class="separator:aea2f243e65074cb174ddf8844c9126ff inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2305ddd73d1ccb8a303abd718cd6e7b0 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a2305ddd73d1ccb8a303abd718cd6e7b0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>scrollArea</b> (int start, int end)</td></tr>
<tr class="separator:a2305ddd73d1ccb8a303abd718cd6e7b0 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcore_1_1TLSSession"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcore_1_1TLSSession')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcore_1_1TLSSession.html">core::TLSSession</a></td></tr>
<tr class="memitem:ac2bd48a18a46a3b6827cd689775e3552 inherit pub_methods_classcore_1_1TLSSession"><td class="memItemLeft" align="right" valign="top"><a id="ac2bd48a18a46a3b6827cd689775e3552"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TLSSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &amp;server)</td></tr>
<tr class="separator:ac2bd48a18a46a3b6827cd689775e3552 inherit pub_methods_classcore_1_1TLSSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae55de8a035d1ddc560cf619b2030af43 inherit pub_methods_classcore_1_1TLSSession"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TLSSession.html#ae55de8a035d1ddc560cf619b2030af43">output</a> (std::stringstream &amp;out)</td></tr>
<tr class="separator:ae55de8a035d1ddc560cf619b2030af43 inherit pub_methods_classcore_1_1TLSSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcore_1_1TCPSession"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcore_1_1TCPSession')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcore_1_1TCPSession.html">core::TCPSession</a></td></tr>
<tr class="memitem:a66e485cd2ba804e6ee4ac11eba3e4fa0 inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="a66e485cd2ba804e6ee4ac11eba3e4fa0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TCPSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &amp;server)</td></tr>
<tr class="separator:a66e485cd2ba804e6ee4ac11eba3e4fa0 inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad593104afcfaabef3c965fe5e0a9dd5 inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="aad593104afcfaabef3c965fe5e0a9dd5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TCPSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &amp;server, std::string text)</td></tr>
<tr class="separator:aad593104afcfaabef3c965fe5e0a9dd5 inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae86d38bd7b58bfb8f8a22c1e2354c3df inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#ae86d38bd7b58bfb8f8a22c1e2354c3df">send</a> (std::string data)</td></tr>
<tr class="separator:ae86d38bd7b58bfb8f8a22c1e2354c3df inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae6bcaf66594f92984e6419b14e8221f inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#aae6bcaf66594f92984e6419b14e8221f">sendToAll</a> (std::string data)</td></tr>
<tr class="separator:aae6bcaf66594f92984e6419b14e8221f inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2219e98dc33f9da2fec1d75597081dfb inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a2219e98dc33f9da2fec1d75597081dfb">sendToAll</a> (<a class="el" href="classcore_1_1SessionFilter.html">SessionFilter</a> filter, std::string data)</td></tr>
<tr class="separator:a2219e98dc33f9da2fec1d75597081dfb inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcore_1_1TCPSocket"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcore_1_1TCPSocket')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcore_1_1TCPSocket.html">core::TCPSocket</a></td></tr>
<tr class="memitem:a09089f0bc701edcf6c148958fd29d374 inherit pub_methods_classcore_1_1TCPSocket"><td class="memItemLeft" align="right" valign="top"><a id="a09089f0bc701edcf6c148958fd29d374"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TCPSocket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll)</td></tr>
<tr class="separator:a09089f0bc701edcf6c148958fd29d374 inherit pub_methods_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7ffbbd17827ffe769684fa8345862d6 inherit pub_methods_classcore_1_1TCPSocket"><td class="memItemLeft" align="right" valign="top"><a id="aa7ffbbd17827ffe769684fa8345862d6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TCPSocket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, std::string text)</td></tr>
<tr class="separator:aa7ffbbd17827ffe769684fa8345862d6 inherit pub_methods_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22dae8f5b7989d206fab918297e0df94 inherit pub_methods_classcore_1_1TCPSocket"><td class="memItemLeft" align="right" valign="top"><a id="a22dae8f5b7989d206fab918297e0df94"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>connect</b> (<a class="el" href="classcore_1_1IPAddress.html">IPAddress</a> &amp;address)</td></tr>
<tr class="separator:a22dae8f5b7989d206fab918297e0df94 inherit pub_methods_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcore_1_1Socket"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcore_1_1Socket')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcore_1_1Socket.html">core::Socket</a></td></tr>
<tr class="memitem:a0009f3813f6d64285f3dad602e4e01cf inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a0009f3813f6d64285f3dad602e4e01cf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Socket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll)</td></tr>
<tr class="separator:a0009f3813f6d64285f3dad602e4e01cf inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36f8a8fda1d79995228b52c2fa01873b inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a36f8a8fda1d79995228b52c2fa01873b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Socket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, std::string text)</td></tr>
<tr class="separator:a36f8a8fda1d79995228b52c2fa01873b inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2d1b6de7a64a9d446b0305b6ec47b31 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31">shutdown</a> (std::string text=&quot;unknown&quot;)</td></tr>
<tr class="separator:af2d1b6de7a64a9d446b0305b6ec47b31 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac44f6ae3196a8a3e09a6a85fcf495762 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">setDescriptor</a> (int descriptor)</td></tr>
<tr class="memdesc:ac44f6ae3196a8a3e09a6a85fcf495762 inherit pub_methods_classcore_1_1Socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the descriptor for the socket. <a href="classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">More...</a><br /></td></tr>
<tr class="separator:ac44f6ae3196a8a3e09a6a85fcf495762 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06ba54744530439d4131e6aba4623d08 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a06ba54744530439d4131e6aba4623d08"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a06ba54744530439d4131e6aba4623d08">getDescriptor</a> ()</td></tr>
<tr class="memdesc:a06ba54744530439d4131e6aba4623d08 inherit pub_methods_classcore_1_1Socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the descriptor for the socket. <br /></td></tr>
<tr class="separator:a06ba54744530439d4131e6aba4623d08 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c9a3396693ff919eb827729f9e72b03 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a4c9a3396693ff919eb827729f9e72b03">eventReceived</a> (struct epoll_event event)</td></tr>
<tr class="memdesc:a4c9a3396693ff919eb827729f9e72b03 inherit pub_methods_classcore_1_1Socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse epoll event and call specified callbacks. <a href="classcore_1_1Socket.html#a4c9a3396693ff919eb827729f9e72b03">More...</a><br /></td></tr>
<tr class="separator:a4c9a3396693ff919eb827729f9e72b03 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1413c826307ef0f29d7457770af675e3 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a1413c826307ef0f29d7457770af675e3">write</a> (std::string data)</td></tr>
<tr class="separator:a1413c826307ef0f29d7457770af675e3 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4855594af113428eacdaa7448d661121 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a4855594af113428eacdaa7448d661121"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (char *buffer, int length)</td></tr>
<tr class="separator:a4855594af113428eacdaa7448d661121 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad67b0f95127bd987b98323120f40f6ed inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="ad67b0f95127bd987b98323120f40f6ed"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>output</b> (std::stringstream &amp;out)</td></tr>
<tr class="separator:ad67b0f95127bd987b98323120f40f6ed inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1d380db54a5b2efbc859e3744bd898b inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#aa1d380db54a5b2efbc859e3744bd898b">onUnregister</a> ()</td></tr>
<tr class="memdesc:aa1d380db54a5b2efbc859e3744bd898b inherit pub_methods_classcore_1_1Socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the socket has finished unregistering for the epoll processing. <a href="classcore_1_1Socket.html#aa1d380db54a5b2efbc859e3744bd898b">More...</a><br /></td></tr>
<tr class="separator:aa1d380db54a5b2efbc859e3744bd898b inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43247bfe43c2be5ab3863d9057d46b7c inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a43247bfe43c2be5ab3863d9057d46b7c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>needsToWrite</b> ()</td></tr>
<tr class="separator:a43247bfe43c2be5ab3863d9057d46b7c inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</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:a9fc306ab91d0f2a6990984040ecb3e47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1ConsoleSession.html#a9fc306ab91d0f2a6990984040ecb3e47">protocol</a> (std::stringstream &amp;out, std::string data) override</td></tr>
<tr class="separator:a9fc306ab91d0f2a6990984040ecb3e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classcore_1_1TLSSession"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcore_1_1TLSSession')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classcore_1_1TLSSession.html">core::TLSSession</a></td></tr>
<tr class="memitem:a1822cb21de545dc1a183ec0bac6cc4f0 inherit pro_methods_classcore_1_1TLSSession"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TLSSession.html#a1822cb21de545dc1a183ec0bac6cc4f0">receiveData</a> (char *buffer, int bufferLength) override</td></tr>
<tr class="separator:a1822cb21de545dc1a183ec0bac6cc4f0 inherit pro_methods_classcore_1_1TLSSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76cec7cf4851eb27abe77a2339344c6d inherit pro_methods_classcore_1_1TLSSession"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d">onRegister</a> ()</td></tr>
<tr class="memdesc:a76cec7cf4851eb27abe77a2339344c6d inherit pro_methods_classcore_1_1TLSSession"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the socket has finished registering with the epoll processing. <a href="classcore_1_1TLSSession.html#a76cec7cf4851eb27abe77a2339344c6d">More...</a><br /></td></tr>
<tr class="separator:a76cec7cf4851eb27abe77a2339344c6d inherit pro_methods_classcore_1_1TLSSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e26fdc9e8a6c573b5a504a1f1b137a9 inherit pro_methods_classcore_1_1TLSSession"><td class="memItemLeft" align="right" valign="top"><a id="a8e26fdc9e8a6c573b5a504a1f1b137a9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>onRegistered</b> ()</td></tr>
<tr class="separator:a8e26fdc9e8a6c573b5a504a1f1b137a9 inherit pro_methods_classcore_1_1TLSSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classcore_1_1TCPSession"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcore_1_1TCPSession')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classcore_1_1TCPSession.html">core::TCPSession</a></td></tr>
<tr class="memitem:aa87aca65cece02a107e7c288a925271f inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#aa87aca65cece02a107e7c288a925271f">onDataReceived</a> (std::string data) override</td></tr>
<tr class="memdesc:aa87aca65cece02a107e7c288a925271f inherit pro_methods_classcore_1_1TCPSession"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when data is received from the socket. <a href="classcore_1_1TCPSession.html#aa87aca65cece02a107e7c288a925271f">More...</a><br /></td></tr>
<tr class="separator:aa87aca65cece02a107e7c288a925271f inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8595f53d21b603a494d246b24dfa8be3 inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a8595f53d21b603a494d246b24dfa8be3">onConnected</a> (std::stringstream &amp;out)</td></tr>
<tr class="separator:a8595f53d21b603a494d246b24dfa8be3 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classcore_1_1Socket"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcore_1_1Socket')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classcore_1_1Socket.html">core::Socket</a></td></tr>
<tr class="memitem:a71c77a162698b9c074a7497beab7b5d8 inherit pro_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a71c77a162698b9c074a7497beab7b5d8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setBufferSize</b> (int length)</td></tr>
<tr class="separator:a71c77a162698b9c074a7497beab7b5d8 inherit pro_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6c06db2441633ae9979affe72930abc inherit pro_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="af6c06db2441633ae9979affe72930abc"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>onDataReceived</b> (char *buffer, int len)</td></tr>
<tr class="separator:af6c06db2441633ae9979affe72930abc inherit pro_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classcore_1_1TerminalSession"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1TerminalSession')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classcore_1_1TerminalSession.html">core::TerminalSession</a></td></tr>
<tr class="memitem:a2a04d42bd95c0c3f44d53cc9a8a471fd inherit pub_attribs_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a2a04d42bd95c0c3f44d53cc9a8a471fd"></a>
std::stringstream&#160;</td><td class="memItemRight" valign="bottom"><b>out</b></td></tr>
<tr class="separator:a2a04d42bd95c0c3f44d53cc9a8a471fd inherit pub_attribs_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classcore_1_1TCPSession"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1TCPSession')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classcore_1_1TCPSession.html">core::TCPSession</a></td></tr>
<tr class="memitem:a2c39191d695d79891989ea628f42c0a8 inherit pub_attribs_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="a2c39191d695d79891989ea628f42c0a8"></a>
<a class="el" href="classcore_1_1Command.html">Command</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>grab</b> = NULL</td></tr>
<tr class="separator:a2c39191d695d79891989ea628f42c0a8 inherit pub_attribs_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a265d9493fa544e601b5ad5fb1663340c inherit pub_attribs_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="a265d9493fa544e601b5ad5fb1663340c"></a>
<a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>server</b></td></tr>
<tr class="separator:a265d9493fa544e601b5ad5fb1663340c inherit pub_attribs_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classcore_1_1TCPSocket"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1TCPSocket')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classcore_1_1TCPSocket.html">core::TCPSocket</a></td></tr>
<tr class="memitem:abe7d0a740dc0c19c058661270a6fb630 inherit pub_attribs_classcore_1_1TCPSocket"><td class="memItemLeft" align="right" valign="top"><a id="abe7d0a740dc0c19c058661270a6fb630"></a>
<a class="el" href="classcore_1_1IPAddress.html">IPAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ipAddress</b></td></tr>
<tr class="separator:abe7d0a740dc0c19c058661270a6fb630 inherit pub_attribs_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classcore_1_1Socket"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1Socket')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classcore_1_1Socket.html">core::Socket</a></td></tr>
<tr class="memitem:a26ce6667b1d883e7a77fcd46ead03f6b inherit pub_attribs_classcore_1_1Socket"><td class="memItemLeft" ><a id="a26ce6667b1d883e7a77fcd46ead03f6b"></a>
class {</td></tr>
<tr class="memitem:a26ce6667b1d883e7a77fcd46ead03f6b inherit pub_attribs_classcore_1_1Socket"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><b>bufferSize</b></td></tr>
<tr class="separator:a26ce6667b1d883e7a77fcd46ead03f6b inherit pub_attribs_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addc8b96547fb9cc921f9fb0e398d4882 inherit pub_attribs_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="addc8b96547fb9cc921f9fb0e398d4882"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>active</b> = false</td></tr>
<tr class="separator:addc8b96547fb9cc921f9fb0e398d4882 inherit pub_attribs_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classcore_1_1Object"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1Object')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classcore_1_1Object.html">core::Object</a></td></tr>
<tr class="memitem:aa096b2bab35f1019c91077ef3ec106ce inherit pub_attribs_classcore_1_1Object"><td class="memItemLeft" align="right" valign="top"><a id="aa096b2bab35f1019c91077ef3ec106ce"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
<tr class="separator:aa096b2bab35f1019c91077ef3ec106ce inherit pub_attribs_classcore_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad503c264c529c41c25528c34421c83df inherit pub_attribs_classcore_1_1Object"><td class="memItemLeft" align="right" valign="top"><a id="ad503c264c529c41c25528c34421c83df"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></tr>
<tr class="separator:ad503c264c529c41c25528c34421c83df inherit pub_attribs_classcore_1_1Object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classcore_1_1Socket"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classcore_1_1Socket')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classcore_1_1Socket.html">core::Socket</a></td></tr>
<tr class="memitem:a3b0b139ac7da581f0d969f6ae9a0c97c inherit pro_attribs_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a3b0b139ac7da581f0d969f6ae9a0c97c"></a>
<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>ePoll</b></td></tr>
<tr class="separator:a3b0b139ac7da581f0d969f6ae9a0c97c inherit pro_attribs_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa09db6c6298d20ea76c6e65f8bffd3dc inherit pro_attribs_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="aa09db6c6298d20ea76c6e65f8bffd3dc"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false</td></tr>
<tr class="separator:aa09db6c6298d20ea76c6e65f8bffd3dc inherit pro_attribs_classcore_1_1Socket"><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><a class="el" href="classcore_1_1ConsoleSession.html">ConsoleSession</a></p>
<p>Extends the session parameters for this <a class="el" href="classcore_1_1TCPSocket.html">TCPSocket</a> derived object. Extend the <a class="el" href="classcore_1_1ConsoleSession.html#a9fc306ab91d0f2a6990984040ecb3e47">protocol()</a> method in order to define the behavior and protocol interaction for this socket which is a console session. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9fc306ab91d0f2a6990984040ecb3e47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fc306ab91d0f2a6990984040ecb3e47">&#9670;&nbsp;</a></span>protocol()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void core::ConsoleSession::protocol </td>
<td>(</td>
<td class="paramtype">std::stringstream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>data</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Override the protocol method to manage and control the session communications in your inherited session. If you do not override this method then the Session default will process the 'commands' added to the server object using the processRequest method on the session input. </p>
<p>Reimplemented from <a class="el" href="classcore_1_1TLSSession.html#ad7f219581d1f7700ca1f88551cd01c74">core::TLSSession</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ConsoleSession_8h_source.html">ConsoleSession.h</a></li>
<li>ConsoleSession.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>