316 lines
38 KiB
HTML
316 lines
38 KiB
HTML
<!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">
|
|
<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.9.1"/>
|
|
<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.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<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> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<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 <<a class="el" href="ConsoleSession_8h_source.html">ConsoleSession.h</a>></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="#acore_1_1ConsoleSession_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="acore_1_1ConsoleSession_inherit__map" id="acore_1_1ConsoleSession_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="7,304,167,331"/>
|
|
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="5,229,169,256"/>
|
|
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="21,155,154,181"/>
|
|
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="24,80,151,107"/>
|
|
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="37,5,138,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="#acore_1_1ConsoleSession_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="acore_1_1ConsoleSession_coll__map" id="acore_1_1ConsoleSession_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="1712,171,1872,197"/>
|
|
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="1499,171,1663,197"/>
|
|
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="1316,171,1449,197"/>
|
|
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="851,281,977,308"/>
|
|
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="1097,171,1223,197"/>
|
|
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="487,323,588,349"/>
|
|
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="185,323,275,349"/>
|
|
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="5,171,131,197"/>
|
|
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="304,221,452,248"/>
|
|
<area shape="rect" href="classcore_1_1SubscriptionManager.html" title=" " alt="" coords="623,73,817,100"/>
|
|
<area shape="rect" href="classcore_1_1IPAddress.html" title=" " alt="" coords="476,272,599,299"/>
|
|
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="180,272,280,299"/>
|
|
<area shape="rect" href="classcore_1_1IPAddressList.html" title=" " alt="" coords="841,120,987,147"/>
|
|
</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>
|
|
 </td><td class="memItemRight" valign="bottom"><b>ConsoleSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &server)</td></tr>
|
|
<tr class="separator:ae735e9739fb4cfd2ef983cc56f9982c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e6b56503966f1cae5bdff8b3814e2b9"><td class="memItemLeft" align="right" valign="top"><a id="a6e6b56503966f1cae5bdff8b3814e2b9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>writeLog</b> (std::string data)</td></tr>
|
|
<tr class="separator:a6e6b56503966f1cae5bdff8b3814e2b9"><td class="memSeparator" colspan="2"> </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="-"/> 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>
|
|
 </td><td class="memItemRight" valign="bottom"><b>TerminalSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &server)</td></tr>
|
|
<tr class="separator:a6773b1897d2e417ab573b28fa127230c inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0df0106164a7f213acf2e814e725c576 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a0df0106164a7f213acf2e814e725c576"></a>
|
|
int </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"> </td></tr>
|
|
<tr class="memitem:a42bb06857891220a831da04248233935 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TerminalSession.html#a42bb06857891220a831da04248233935">clear</a> ()</td></tr>
|
|
<tr class="separator:a42bb06857891220a831da04248233935 inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa660768eed03b0b996a749e8a146446c inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TerminalSession.html#aa660768eed03b0b996a749e8a146446c">clearEOL</a> ()</td></tr>
|
|
<tr class="separator:aa660768eed03b0b996a749e8a146446c inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9939cbe36c08e1a0b8413a96ca251fa inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TerminalSession.html#aa9939cbe36c08e1a0b8413a96ca251fa">setCursorLocation</a> (int x, int y)</td></tr>
|
|
<tr class="separator:aa9939cbe36c08e1a0b8413a96ca251fa inherit pub_methods_classcore_1_1TerminalSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb104a3743f52c8237afc25c9abd3815 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="abb104a3743f52c8237afc25c9abd3815"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:a96c909e28a87f2e5b64fe2ca7ab79ca7 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a96c909e28a87f2e5b64fe2ca7ab79ca7"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:a930de98aea34eca4723a1efbc0272223 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a930de98aea34eca4723a1efbc0272223"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:afc89dc99e1b104bee7717b0cda2f9b37 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="afc89dc99e1b104bee7717b0cda2f9b37"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:a21f8ec433bcb4c7f55807cdcbc929134 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a21f8ec433bcb4c7f55807cdcbc929134"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:aea2f243e65074cb174ddf8844c9126ff inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="aea2f243e65074cb174ddf8844c9126ff"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:a2305ddd73d1ccb8a303abd718cd6e7b0 inherit pub_methods_classcore_1_1TerminalSession"><td class="memItemLeft" align="right" valign="top"><a id="a2305ddd73d1ccb8a303abd718cd6e7b0"></a>
|
|
void </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"> </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="-"/> Public Member Functions inherited from <a class="el" href="classcore_1_1TCPSession.html">core::TCPSession</a></td></tr>
|
|
<tr class="memitem:a7e1192babcdeb688f463d3e9e85d0979 inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="a7e1192babcdeb688f463d3e9e85d0979"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>TCPSession</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, <a class="el" href="classcore_1_1TCPServer.html">TCPServer</a> &server, std::string text="")</td></tr>
|
|
<tr class="separator:a7e1192babcdeb688f463d3e9e85d0979 inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50037cbfc515650e04054e5481785981 inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a50037cbfc515650e04054e5481785981">output</a> (std::stringstream &data)</td></tr>
|
|
<tr class="separator:a50037cbfc515650e04054e5481785981 inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b09eeafef5e44009a77d9da43e3b889 inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a2b09eeafef5e44009a77d9da43e3b889">send</a> ()</td></tr>
|
|
<tr class="separator:a2b09eeafef5e44009a77d9da43e3b889 inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34936745e8d7669d5400e78d353a56d3 inherit pub_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a34936745e8d7669d5400e78d353a56d3">terminate</a> ()</td></tr>
|
|
<tr class="separator:a34936745e8d7669d5400e78d353a56d3 inherit pub_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </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="-"/> 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>
|
|
 </td><td class="memItemRight" valign="bottom"><b>TCPSocket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll)</td></tr>
|
|
<tr class="separator:a09089f0bc701edcf6c148958fd29d374 inherit pub_methods_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7ffbbd17827ffe769684fa8345862d6 inherit pub_methods_classcore_1_1TCPSocket"><td class="memItemLeft" align="right" valign="top"><a id="aa7ffbbd17827ffe769684fa8345862d6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>TCPSocket</b> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, std::string text)</td></tr>
|
|
<tr class="separator:aa7ffbbd17827ffe769684fa8345862d6 inherit pub_methods_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22dae8f5b7989d206fab918297e0df94 inherit pub_methods_classcore_1_1TCPSocket"><td class="memItemLeft" align="right" valign="top"><a id="a22dae8f5b7989d206fab918297e0df94"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>connect</b> (<a class="el" href="classcore_1_1IPAddress.html">IPAddress</a> &address)</td></tr>
|
|
<tr class="separator:a22dae8f5b7989d206fab918297e0df94 inherit pub_methods_classcore_1_1TCPSocket"><td class="memSeparator" colspan="2"> </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="-"/> Public Member Functions inherited from <a class="el" href="classcore_1_1Socket.html">core::Socket</a></td></tr>
|
|
<tr class="memitem:a4c3f87fd1de3c9eab4bf5efbb30ce87d inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a4c3f87fd1de3c9eab4bf5efbb30ce87d">Socket</a> (<a class="el" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, std::string text="")</td></tr>
|
|
<tr class="separator:a4c3f87fd1de3c9eab4bf5efbb30ce87d inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5003845f8ae464ad2fa206176381be0 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#aa5003845f8ae464ad2fa206176381be0">~Socket</a> ()</td></tr>
|
|
<tr class="separator:aa5003845f8ae464ad2fa206176381be0 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af2d1b6de7a64a9d446b0305b6ec47b31 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31">shutdown</a> (std::string text="unknown")</td></tr>
|
|
<tr class="separator:af2d1b6de7a64a9d446b0305b6ec47b31 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac44f6ae3196a8a3e09a6a85fcf495762 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
|
|
<tr class="memitem:a06ba54744530439d4131e6aba4623d08 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a06ba54744530439d4131e6aba4623d08"></a>
|
|
int </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"> </td><td class="mdescRight">Get the descriptor for the socket. <br />
|
|
<br /></td></tr>
|
|
<tr class="separator:a06ba54744530439d4131e6aba4623d08 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c9a3396693ff919eb827729f9e72b03 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:a1413c826307ef0f29d7457770af675e3 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">int </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"> </td></tr>
|
|
<tr class="memitem:a4855594af113428eacdaa7448d661121 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a4855594af113428eacdaa7448d661121"></a>
|
|
void </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"> </td></tr>
|
|
<tr class="memitem:ad67b0f95127bd987b98323120f40f6ed inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="ad67b0f95127bd987b98323120f40f6ed"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>output</b> (std::stringstream &out)</td></tr>
|
|
<tr class="separator:ad67b0f95127bd987b98323120f40f6ed inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81e5ee3e17834166d97c6e8b7dfe0da0 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0">onRegister</a> ()</td></tr>
|
|
<tr class="memdesc:a81e5ee3e17834166d97c6e8b7dfe0da0 inherit pub_methods_classcore_1_1Socket"><td class="mdescLeft"> </td><td class="mdescRight">Called before the socket has registered with the epoll processing. <a href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0">More...</a><br /></td></tr>
|
|
<tr class="separator:a81e5ee3e17834166d97c6e8b7dfe0da0 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1d380db54a5b2efbc859e3744bd898b inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="aa1d380db54a5b2efbc859e3744bd898b"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>onUnregister</b> ()</td></tr>
|
|
<tr class="separator:aa1d380db54a5b2efbc859e3744bd898b inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9be59697c2b2e5efb19aaae3ba943d2 inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#ae9be59697c2b2e5efb19aaae3ba943d2">onUnregistered</a> ()</td></tr>
|
|
<tr class="memdesc:ae9be59697c2b2e5efb19aaae3ba943d2 inherit pub_methods_classcore_1_1Socket"><td class="mdescLeft"> </td><td class="mdescRight">Called when the socket has finished unregistering for the epoll processing. <a href="classcore_1_1Socket.html#ae9be59697c2b2e5efb19aaae3ba943d2">More...</a><br /></td></tr>
|
|
<tr class="separator:ae9be59697c2b2e5efb19aaae3ba943d2 inherit pub_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43247bfe43c2be5ab3863d9057d46b7c inherit pub_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a43247bfe43c2be5ab3863d9057d46b7c"></a>
|
|
bool </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"> </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:aa1818efcd33a4152d2089aa545f08833"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833">protocol</a> (coreutils::ZString &data) override</td></tr>
|
|
<tr class="separator:aa1818efcd33a4152d2089aa545f08833"><td class="memSeparator" colspan="2"> </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="-"/> Protected Member Functions inherited from <a class="el" href="classcore_1_1TCPSession.html">core::TCPSession</a></td></tr>
|
|
<tr class="memitem:aed4ed499b978bcea57a8efefe929fc98 inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="aed4ed499b978bcea57a8efefe929fc98"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#aed4ed499b978bcea57a8efefe929fc98">onRegistered</a> () override</td></tr>
|
|
<tr class="memdesc:aed4ed499b978bcea57a8efefe929fc98 inherit pro_methods_classcore_1_1TCPSession"><td class="mdescLeft"> </td><td class="mdescRight">Called after the socket has been registered with epoll processing. <br /></td></tr>
|
|
<tr class="separator:aed4ed499b978bcea57a8efefe929fc98 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc2d2a92bc65e1e5122a93d120253a1d inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#afc2d2a92bc65e1e5122a93d120253a1d">onDataReceived</a> (coreutils::ZString &data) override</td></tr>
|
|
<tr class="separator:afc2d2a92bc65e1e5122a93d120253a1d inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d9e0f14e7d24357fd1950b3f9b4eaff inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a3d9e0f14e7d24357fd1950b3f9b4eaff">onLineReceived</a> (coreutils::ZString &line)</td></tr>
|
|
<tr class="separator:a3d9e0f14e7d24357fd1950b3f9b4eaff inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c996cbbfa2e592c23cf67ed8b15a32a inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a9c996cbbfa2e592c23cf67ed8b15a32a">onBlockReceived</a> (coreutils::ZString &block)</td></tr>
|
|
<tr class="separator:a9c996cbbfa2e592c23cf67ed8b15a32a inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8719952f7bb00bf7239ec40aa2868626 inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a8719952f7bb00bf7239ec40aa2868626">onConnected</a> ()</td></tr>
|
|
<tr class="separator:a8719952f7bb00bf7239ec40aa2868626 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a836fb3fd5ee543ebc93262a980ae88b5 inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a836fb3fd5ee543ebc93262a980ae88b5">setBlockSize</a> (int size=0)</td></tr>
|
|
<tr class="separator:a836fb3fd5ee543ebc93262a980ae88b5 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </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="-"/> 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 </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"> </td></tr>
|
|
<tr class="memitem:aa9195676bb7ecbec167ecf5336921cbb inherit pro_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="aa9195676bb7ecbec167ecf5336921cbb"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>getBufferSize</b> ()</td></tr>
|
|
<tr class="separator:aa9195676bb7ecbec167ecf5336921cbb inherit pro_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8d6a2c54696eb6fc2024cf6bcf6b4e5 inherit pro_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">onDataReceived</a> (std::string data)</td></tr>
|
|
<tr class="memdesc:ac8d6a2c54696eb6fc2024cf6bcf6b4e5 inherit pro_methods_classcore_1_1Socket"><td class="mdescLeft"> </td><td class="mdescRight">Called when data is received from the socket. <a href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">More...</a><br /></td></tr>
|
|
<tr class="separator:ac8d6a2c54696eb6fc2024cf6bcf6b4e5 inherit pro_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46ed2e240852d3fa949979ebbc4ac875 inherit pro_methods_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Socket.html#a46ed2e240852d3fa949979ebbc4ac875">receiveData</a> (coreutils::ZString &buffer)</td></tr>
|
|
<tr class="separator:a46ed2e240852d3fa949979ebbc4ac875 inherit pro_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </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_1TCPSession"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classcore_1_1TCPSession')"><img src="closed.png" alt="-"/> 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> * </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"> </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> & </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"> </td></tr>
|
|
<tr class="memitem:abb302bbb3d7e7bc75490c736364f0d4d inherit pub_attribs_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">std::stringstream </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#abb302bbb3d7e7bc75490c736364f0d4d">out</a></td></tr>
|
|
<tr class="separator:abb302bbb3d7e7bc75490c736364f0d4d inherit pub_attribs_classcore_1_1TCPSession"><td class="memSeparator" colspan="2"> </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="-"/> 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> </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"> </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="-"/> Public Attributes inherited from <a class="el" href="classcore_1_1Socket.html">core::Socket</a></td></tr>
|
|
<tr class="memitem:a9f9a89f5caab42f77b3759ceb54a0a78 inherit pub_attribs_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a9f9a89f5caab42f77b3759ceb54a0a78"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>reset</b> = false</td></tr>
|
|
<tr class="separator:a9f9a89f5caab42f77b3759ceb54a0a78 inherit pub_attribs_classcore_1_1Socket"><td class="memSeparator" colspan="2"> </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="-"/> 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> & </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"> </td></tr>
|
|
<tr class="memitem:aa09db6c6298d20ea76c6e65f8bffd3dc inherit pro_attribs_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="aa09db6c6298d20ea76c6e65f8bffd3dc"></a>
|
|
bool </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"> </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#aa1818efcd33a4152d2089aa545f08833">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="aa1818efcd33a4152d2089aa545f08833"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa1818efcd33a4152d2089aa545f08833">◆ </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">coreutils::ZString & </td>
|
|
<td class="paramname"><em>data</em></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>When data is received within the session two modes are available to pass the data through the protocol method: LINE or BLOCK. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classcore_1_1TCPSession.html#a98a65da2346b79bee659fca6902e94c7">core::TCPSession</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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|