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_1TCPSession.html
+41 -49
View File
@@ -81,13 +81,12 @@ Inheritance diagram for core::TCPSession:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1TCPSession__inherit__graph.png" border="0" usemap="#core_1_1TCPSession_inherit__map" alt="Inheritance graph"/></div>
<map name="core_1_1TCPSession_inherit__map" id="core_1_1TCPSession_inherit__map">
<area shape="rect" title=" " alt="" coords="106,229,239,256"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="5,304,169,331"/>
<area shape="rect" href="classcore_1_1TLSSession.html" title=" " alt="" coords="194,304,325,331"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="109,155,236,181"/>
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="122,80,223,107"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="123,5,223,32"/>
<area shape="rect" href="classcore_1_1ConsoleSession.html" title=" " alt="" coords="7,379,167,405"/>
<area shape="rect" title=" " alt="" coords="106,155,239,181"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="5,229,169,256"/>
<area shape="rect" href="classcore_1_1TLSSession.html" title=" " alt="" coords="194,229,325,256"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="109,80,236,107"/>
<area shape="rect" href="classcore_1_1Socket.html" title=" " alt="" coords="122,5,223,32"/>
<area shape="rect" href="classcore_1_1ConsoleSession.html" title=" " alt="" coords="7,304,167,331"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
@@ -95,16 +94,16 @@ Collaboration diagram for core::TCPSession:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1TCPSession__coll__graph.png" border="0" usemap="#core_1_1TCPSession_coll__map" alt="Collaboration graph"/></div>
<map name="core_1_1TCPSession_coll__map" id="core_1_1TCPSession_coll__map">
<area shape="rect" 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="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">
@@ -173,11 +172,11 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a2c39191d695d79891989ea628f42c0a8"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb302bbb3d7e7bc75490c736364f0d4d"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a265d9493fa544e601b5ad5fb1663340c"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb302bbb3d7e7bc75490c736364f0d4d"><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"><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>
@@ -186,13 +185,6 @@ Public Attributes</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>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
@@ -200,16 +192,16 @@ Protected Member Functions</h2></td></tr>
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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6683cc5b39d3e47adc9ead3f3e3d7587"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a018d0458806811b98e4aa30da27a1a2d"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada0eb595b5c506ae2f74851fd1588512"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc2d2a92bc65e1e5122a93d120253a1d"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d9e0f14e7d24357fd1950b3f9b4eaff"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c996cbbfa2e592c23cf67ed8b15a32a"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8719952f7bb00bf7239ec40aa2868626"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a2a34c9b1252664e93c576a27c30720"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a4a2a34c9b1252664e93c576a27c30720">protocol</a> (coreutils::ZString data)</td></tr>
<tr class="separator:a4a2a34c9b1252664e93c576a27c30720"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98a65da2346b79bee659fca6902e94c7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#a98a65da2346b79bee659fca6902e94c7">protocol</a> (coreutils::ZString &amp;data)</td></tr>
<tr class="separator:a98a65da2346b79bee659fca6902e94c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a836fb3fd5ee543ebc93262a980ae88b5"><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>
<tr class="separator:a836fb3fd5ee543ebc93262a980ae88b5"><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>
@@ -222,8 +214,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>
@@ -239,8 +231,8 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<div class="textblock"><p><a class="el" href="classcore_1_1TCPSession.html">TCPSession</a></p>
<p><a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> defines the nature of the interaction with the client and stores persistent data for a defined session. <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> objects are not sockets but instead provide a communications control mechanism. Protocol conversations are provided through extensions from this object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ada0eb595b5c506ae2f74851fd1588512"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada0eb595b5c506ae2f74851fd1588512">&#9670;&nbsp;</a></span>onBlockReceived()</h2>
<a id="a9c996cbbfa2e592c23cf67ed8b15a32a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c996cbbfa2e592c23cf67ed8b15a32a">&#9670;&nbsp;</a></span>onBlockReceived()</h2>
<div class="memitem">
<div class="memproto">
@@ -251,7 +243,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<tr>
<td class="memname">void core::TCPSession::onBlockReceived </td>
<td>(</td>
<td class="paramtype">coreutils::ZString&#160;</td>
<td class="paramtype">coreutils::ZString &amp;&#160;</td>
<td class="paramname"><em>block</em></td><td>)</td>
<td></td>
</tr>
@@ -292,8 +284,8 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div>
</div>
<a id="a6683cc5b39d3e47adc9ead3f3e3d7587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6683cc5b39d3e47adc9ead3f3e3d7587">&#9670;&nbsp;</a></span>onDataReceived()</h2>
<a id="afc2d2a92bc65e1e5122a93d120253a1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc2d2a92bc65e1e5122a93d120253a1d">&#9670;&nbsp;</a></span>onDataReceived()</h2>
<div class="memitem">
<div class="memproto">
@@ -304,7 +296,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<tr>
<td class="memname">void core::TCPSession::onDataReceived </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>
@@ -321,8 +313,8 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div>
</div>
<a id="a018d0458806811b98e4aa30da27a1a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a018d0458806811b98e4aa30da27a1a2d">&#9670;&nbsp;</a></span>onLineReceived()</h2>
<a id="a3d9e0f14e7d24357fd1950b3f9b4eaff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d9e0f14e7d24357fd1950b3f9b4eaff">&#9670;&nbsp;</a></span>onLineReceived()</h2>
<div class="memitem">
<div class="memproto">
@@ -333,7 +325,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<tr>
<td class="memname">void core::TCPSession::onLineReceived </td>
<td>(</td>
<td class="paramtype">coreutils::ZString&#160;</td>
<td class="paramtype">coreutils::ZString &amp;&#160;</td>
<td class="paramname"><em>line</em></td><td>)</td>
<td></td>
</tr>
@@ -379,8 +371,8 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div>
</div>
<a id="a4a2a34c9b1252664e93c576a27c30720"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a2a34c9b1252664e93c576a27c30720">&#9670;&nbsp;</a></span>protocol()</h2>
<a id="a98a65da2346b79bee659fca6902e94c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98a65da2346b79bee659fca6902e94c7">&#9670;&nbsp;</a></span>protocol()</h2>
<div class="memitem">
<div class="memproto">
@@ -391,7 +383,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<tr>
<td class="memname">void core::TCPSession::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>
@@ -405,7 +397,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 in <a class="el" href="classcore_1_1TLSSession.html#a2ff61cfcb3ffd3593b1bf7b39343ee56">core::TLSSession</a>, and <a class="el" href="classcore_1_1ConsoleSession.html#a72cd8a1ed55112b7245d889a9424fd64">core::ConsoleSession</a>.</p>
<p>Reimplemented in <a class="el" href="classcore_1_1TLSSession.html#a208145cc1fcdc14054602aacc2c51d91">core::TLSSession</a>, and <a class="el" href="classcore_1_1ConsoleSession.html#aa1818efcd33a4152d2089aa545f08833">core::ConsoleSession</a>.</p>
</div>
</div>