barant/ServerCore
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update changes.

Browse Source
This commit is contained in:
barant committed 2021-08-14 15:03:43 -07:00
1 parent 86bd62221f
commit 608f8a2b0c
249 files changed
+1562 -1734
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

html/classcore_1_1ConsoleSession.html
+34 -42
View File
@@ -80,12 +80,11 @@ 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" title=" " alt="" coords="7,379,167,405"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="5,304,169,331"/>
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="21,229,154,256"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="24,155,151,181"/>
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="37,80,138,107"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="37,5,137,32"/>
<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">
@@ -93,18 +92,18 @@ 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" title=" " alt="" coords="239,719,399,745"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="237,643,401,669"/>
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="252,567,385,593"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="110,373,237,400"/>
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="256,477,381,504"/>
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="5,284,107,311"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="91,5,191,32"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="244,81,369,108"/>
<area shape="rect" href="classcore_1_1IPAddress.html" title=" " alt="" coords="80,132,203,159"/>
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="179,183,269,209"/>
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="323,233,471,260"/>
<area shape="rect" href="classcore_1_1IPAddressList.html" title=" " alt="" coords="391,373,537,400"/>
<area shape="rect" title=" " alt="" coords="147,617,307,644"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="145,541,309,568"/>
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="160,465,293,492"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="163,272,290,299"/>
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="265,376,391,403"/>
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="189,183,291,209"/>
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="189,81,280,108"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="244,5,369,32"/>
<area shape="rect" href="classcore_1_1CommandList.html" title=" " alt="" coords="266,132,414,159"/>
<area shape="rect" href="classcore_1_1IPAddress.html" title=" " alt="" coords="43,183,165,209"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="54,81,154,108"/>
<area shape="rect" href="classcore_1_1IPAddressList.html" title=" " alt="" coords="366,272,511,299"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
@@ -211,19 +210,19 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>needsToWrite</b> ()</
</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:a72cd8a1ed55112b7245d889a9424fd64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1ConsoleSession.html#a72cd8a1ed55112b7245d889a9424fd64">protocol</a> (coreutils::ZString data) override</td></tr>
<tr class="separator:a72cd8a1ed55112b7245d889a9424fd64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1818efcd33a4152d2089aa545f08833"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833">protocol</a> (coreutils::ZString &amp;data) override</td></tr>
<tr class="separator:aa1818efcd33a4152d2089aa545f08833"><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:aed4ed499b978bcea57a8efefe929fc98 inherit pro_methods_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top"><a id="aed4ed499b978bcea57a8efefe929fc98"></a>
virtual void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a6683cc5b39d3e47adc9ead3f3e3d7587 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#a6683cc5b39d3e47adc9ead3f3e3d7587">onDataReceived</a> (coreutils::ZString data) override</td></tr>
<tr class="separator:a6683cc5b39d3e47adc9ead3f3e3d7587 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a018d0458806811b98e4aa30da27a1a2d 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#a018d0458806811b98e4aa30da27a1a2d">onLineReceived</a> (coreutils::ZString line)</td></tr>
<tr class="separator:a018d0458806811b98e4aa30da27a1a2d inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada0eb595b5c506ae2f74851fd1588512 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#ada0eb595b5c506ae2f74851fd1588512">onBlockReceived</a> (coreutils::ZString block)</td></tr>
<tr class="separator:ada0eb595b5c506ae2f74851fd1588512 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc2d2a92bc65e1e5122a93d120253a1d 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#afc2d2a92bc65e1e5122a93d120253a1d">onDataReceived</a> (coreutils::ZString &amp;data) override</td></tr>
<tr class="separator:afc2d2a92bc65e1e5122a93d120253a1d inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d9e0f14e7d24357fd1950b3f9b4eaff 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#a3d9e0f14e7d24357fd1950b3f9b4eaff">onLineReceived</a> (coreutils::ZString &amp;line)</td></tr>
<tr class="separator:a3d9e0f14e7d24357fd1950b3f9b4eaff inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c996cbbfa2e592c23cf67ed8b15a32a 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#a9c996cbbfa2e592c23cf67ed8b15a32a">onBlockReceived</a> (coreutils::ZString &amp;block)</td></tr>
<tr class="separator:a9c996cbbfa2e592c23cf67ed8b15a32a inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8719952f7bb00bf7239ec40aa2868626 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#a8719952f7bb00bf7239ec40aa2868626">onConnected</a> ()</td></tr>
<tr class="separator:a8719952f7bb00bf7239ec40aa2868626 inherit pro_methods_classcore_1_1TCPSession"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836fb3fd5ee543ebc93262a980ae88b5 inherit pro_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#a836fb3fd5ee543ebc93262a980ae88b5">setBlockSize</a> (int size=0)</td></tr>
@@ -238,8 +237,8 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>getBufferSize</b> ()</
<tr class="memitem:ac8d6a2c54696eb6fc2024cf6bcf6b4e5 inherit pro_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#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">onDataReceived</a> (std::string data)</td></tr>
<tr class="memdesc:ac8d6a2c54696eb6fc2024cf6bcf6b4e5 inherit pro_methods_classcore_1_1Socket"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a481b3b3874a6862f8d97030297cc6f32 inherit pro_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#a481b3b3874a6862f8d97030297cc6f32">receiveData</a> (coreutils::ZString buffer)</td></tr>
<tr class="separator:a481b3b3874a6862f8d97030297cc6f32 inherit pro_methods_classcore_1_1Socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46ed2e240852d3fa949979ebbc4ac875 inherit pro_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#a46ed2e240852d3fa949979ebbc4ac875">receiveData</a> (coreutils::ZString &amp;buffer)</td></tr>
<tr class="separator:a46ed2e240852d3fa949979ebbc4ac875 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>
@@ -247,11 +246,11 @@ Additional Inherited Members</h2></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:abb302bbb3d7e7bc75490c736364f0d4d inherit pub_attribs_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">std::stringstream&#160;</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">&#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="memitem:abb302bbb3d7e7bc75490c736364f0d4d inherit pub_attribs_classcore_1_1TCPSession"><td class="memItemLeft" align="right" valign="top">std::stringstream&#160;</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">&#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>
@@ -260,13 +259,6 @@ Additional Inherited Members</h2></td></tr>
<tr class="memitem:a9f9a89f5caab42f77b3759ceb54a0a78 inherit pub_attribs_classcore_1_1Socket"><td class="memItemLeft" align="right" valign="top"><a id="a9f9a89f5caab42f77b3759ceb54a0a78"></a>
bool&#160;</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">&#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>
@@ -277,10 +269,10 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</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#a72cd8a1ed55112b7245d889a9424fd64">protocol()</a> method in order to define the behavior and protocol interaction for this socket which is a console session. </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="a72cd8a1ed55112b7245d889a9424fd64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72cd8a1ed55112b7245d889a9424fd64">&#9670;&nbsp;</a></span>protocol()</h2>
<a id="aa1818efcd33a4152d2089aa545f08833"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1818efcd33a4152d2089aa545f08833">&#9670;&nbsp;</a></span>protocol()</h2>
<div class="memitem">
<div class="memproto">
@@ -291,7 +283,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<tr>
<td class="memname">void core::ConsoleSession::protocol </td>
<td>(</td>
<td class="paramtype">coreutils::ZString&#160;</td>
<td class="paramtype">coreutils::ZString &amp;&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
@@ -305,7 +297,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<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#a4a2a34c9b1252664e93c576a27c30720">core::TCPSession</a>.</p>
<p>Reimplemented from <a class="el" href="classcore_1_1TCPSession.html#a98a65da2346b79bee659fca6902e94c7">core::TCPSession</a>.</p>
</div>
</div>