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_1Socket.html
+26 -36
View File
@@ -82,20 +82,19 @@ Inheritance diagram for core::Socket:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1Socket__inherit__graph.png" border="0" usemap="#core_1_1Socket_inherit__map" alt="Inheritance graph"/></div>
<map name="core_1_1Socket_inherit__map" id="core_1_1Socket_inherit__map">
<area shape="rect" title=" " alt="" coords="379,80,480,107"/>
<area shape="rect" href="classcore_1_1INotify.html" title=" " alt="" coords="173,155,275,181"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="299,155,426,181"/>
<area shape="rect" href="classcore_1_1Timer.html" title=" " alt="" coords="450,155,545,181"/>
<area shape="rect" href="classcore_1_1UDPSocket.html" title=" " alt="" coords="569,155,698,181"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="379,5,479,32"/>
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="180,229,305,256"/>
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="344,229,477,256"/>
<area shape="rect" href="classcore_1_1ConsoleServer.html" title=" " alt="" coords="5,304,157,331"/>
<area shape="rect" href="classcore_1_1TLSServer.html" title=" " alt="" coords="181,304,304,331"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="329,304,493,331"/>
<area shape="rect" href="classcore_1_1TLSSession.html" title=" " alt="" coords="517,304,648,331"/>
<area shape="rect" href="classcore_1_1ConsoleSession.html" title=" " alt="" coords="331,379,491,405"/>
<area shape="rect" href="classcore_1_1UDPServerSocket.html" title=" " alt="" coords="548,229,719,256"/>
<area shape="rect" title=" " alt="" coords="380,5,481,32"/>
<area shape="rect" href="classcore_1_1INotify.html" title=" " alt="" coords="174,80,277,107"/>
<area shape="rect" href="classcore_1_1TCPSocket.html" title=" " alt="" coords="301,80,427,107"/>
<area shape="rect" href="classcore_1_1Timer.html" title=" " alt="" coords="451,80,546,107"/>
<area shape="rect" href="classcore_1_1UDPSocket.html" title=" " alt="" coords="570,80,699,107"/>
<area shape="rect" href="classcore_1_1TCPServer.html" title=" " alt="" coords="180,155,305,181"/>
<area shape="rect" href="classcore_1_1TCPSession.html" title=" " alt="" coords="344,155,477,181"/>
<area shape="rect" href="classcore_1_1ConsoleServer.html" title=" " alt="" coords="5,229,157,256"/>
<area shape="rect" href="classcore_1_1TLSServer.html" title=" " alt="" coords="181,229,304,256"/>
<area shape="rect" href="classcore_1_1TerminalSession.html" title=" " alt="" coords="329,229,493,256"/>
<area shape="rect" href="classcore_1_1TLSSession.html" title=" " alt="" coords="517,229,648,256"/>
<area shape="rect" href="classcore_1_1ConsoleSession.html" title=" " alt="" coords="331,304,491,331"/>
<area shape="rect" href="classcore_1_1UDPServerSocket.html" title=" " alt="" coords="549,155,720,181"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
@@ -103,10 +102,9 @@ Collaboration diagram for core::Socket:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1Socket__coll__graph.png" border="0" usemap="#core_1_1Socket_coll__map" alt="Collaboration graph"/></div>
<map name="core_1_1Socket_coll__map" id="core_1_1Socket_coll__map">
<area shape="rect" title=" " alt="" coords="10,247,111,273"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="5,5,105,32"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="77,81,202,108"/>
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="81,157,171,184"/>
<area shape="rect" title=" " alt="" coords="17,171,119,197"/>
<area shape="rect" href="classcore_1_1EPoll.html" title=" " alt="" coords="23,81,113,108"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="5,5,131,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
@@ -159,13 +157,6 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a9f9a89f5caab42f77b3759ceb54a0a78"><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"><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>
@@ -178,11 +169,11 @@ int&#160;</td><td class="memItemRight" valign="bottom"><b>getBufferSize</b> ()</
<tr class="memitem:ac8d6a2c54696eb6fc2024cf6bcf6b4e5"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b212533877a49c965a3aaa05f22d03"><td class="memItemLeft" align="right" valign="top"><a id="aa1b212533877a49c965a3aaa05f22d03"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>onDataReceived</b> (coreutils::ZString data)</td></tr>
<tr class="separator:aa1b212533877a49c965a3aaa05f22d03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a481b3b3874a6862f8d97030297cc6f32"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae048b57ac2c34381378f3da0e758b3c8"><td class="memItemLeft" align="right" valign="top"><a id="ae048b57ac2c34381378f3da0e758b3c8"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>onDataReceived</b> (coreutils::ZString &amp;data)</td></tr>
<tr class="separator:ae048b57ac2c34381378f3da0e758b3c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46ed2e240852d3fa949979ebbc4ac875"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
@@ -196,8 +187,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classcore_1_1Socket.html">Socket</a></p>
<p>The core component to managing a socket.</p>
<p>Hooks into the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> object and also provides buffering for output data requests to the socket. <br />
</p>
<p>Hooks into the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> through the registration and unregistration process and provides a communication socket of the specified protocol type. This object provides for all receiving data threading through use of the <a class="el" href="classcore_1_1EPoll.html">EPoll</a> object and also provides buffering for output data requests to the socket.</p>
<p>A program using a socket object can request to open a socket (network or device) and communicate through the streambuffer interface of the socket object.</p>
<p>The socket side of the <a class="el" href="classcore_1_1Socket.html">Socket</a> accepts EPOLLIN event and will maintain the data in a buffer for the stream readers to read. A onDataReceived event is then sent with the data received in the buffer that can be read through the stream. Only sockets that send events to epoll can be used with this object.</p>
<p>When writing to the stream the data is written into a buffer and a EPOLLOUT is scheduled. Upon receiving the EPOLLOUT event then the buffer is written to the socket output. </p>
@@ -374,8 +364,8 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div>
</div>
<a id="a481b3b3874a6862f8d97030297cc6f32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a481b3b3874a6862f8d97030297cc6f32">&#9670;&nbsp;</a></span>receiveData()</h2>
<a id="a46ed2e240852d3fa949979ebbc4ac875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46ed2e240852d3fa949979ebbc4ac875">&#9670;&nbsp;</a></span>receiveData()</h2>
<div class="memitem">
<div class="memproto">
@@ -386,7 +376,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<tr>
<td class="memname">void core::Socket::receiveData </td>
<td>(</td>
<td class="paramtype">coreutils::ZString&#160;</td>
<td class="paramtype">coreutils::ZString &amp;&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
@@ -399,7 +389,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div><div class="memdoc">
<p>receiveData will read the data from the socket and place it in the socket buffer. TLS layer overrides this to be able to read from SSL. </p>
<p>Reimplemented in <a class="el" href="classcore_1_1TLSSession.html#a4b3c2d871d83150974bba48435eaf6cf">core::TLSSession</a>.</p>
<p>Reimplemented in <a class="el" href="classcore_1_1TLSSession.html#a8507cdcd23ac4b340ce6f6d5f0b26a52">core::TLSSession</a>.</p>
</div>
</div>