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

Have the thing compiling and delivering pages.

Browse Source
This commit is contained in:
barant committed 2020-12-03 14:06:36 -08:00
1 parent bcea21cf96
commit 6969ef0fbb
30 files changed
+235 -291
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

html/classcore_1_1TCPSession.html
+12 -51
View File
@@ -200,7 +200,9 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
</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:aed4ed499b978bcea57a8efefe929fc98"><td class="memItemLeft" align="right" valign="top">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="memitem:aed4ed499b978bcea57a8efefe929fc98"><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"><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:ac2c3ffef9ded12a8867e3d27902b001a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#ac2c3ffef9ded12a8867e3d27902b001a">onDataReceived</a> (char *data, int len) override</td></tr>
<tr class="separator:ac2c3ffef9ded12a8867e3d27902b001a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -212,8 +214,8 @@ Protected Member Functions</h2></td></tr>
<tr class="separator:a8719952f7bb00bf7239ec40aa2868626"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae90dc64e2d3c4b3239117923145edb3f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#ae90dc64e2d3c4b3239117923145edb3f">protocol</a> (std::string data)</td></tr>
<tr class="separator:ae90dc64e2d3c4b3239117923145edb3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afde7a264edac9e91b509f13eb4192038"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1TCPSession.html#afde7a264edac9e91b509f13eb4192038">setMode</a> (core::Mode mode, int size=0)</td></tr>
<tr class="separator:afde7a264edac9e91b509f13eb4192038"><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>
<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>
@@ -239,8 +241,7 @@ 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_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. <br />
</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="a4403ef0a92b119dfa2e74667788e4ba1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4403ef0a92b119dfa2e74667788e4ba1">&#9670;&nbsp;</a></span>onBlockReceived()</h2>
@@ -359,36 +360,6 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div><div class="memdoc">
<p>Override the onLineReceived method to receive a string of characters that represents a single line of data terminated by a LF or CRLF. If onDataReceived was overriden this method will not be called unless the onDataReceived calls this method explicitly using the class and member name. </p>
</div>
</div>
<a id="aed4ed499b978bcea57a8efefe929fc98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed4ed499b978bcea57a8efefe929fc98">&#9670;&nbsp;</a></span>onRegistered()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void core::TCPSession::onRegistered </td>
<td>(</td>
<td class="paramname"></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>Set this value to control the next read event coming from this socket. </p>
<p>Reimplemented from <a class="el" href="classcore_1_1Socket.html#a23b9824653bbe4652a716acb828665b1">core::Socket</a>.</p>
<p>Reimplemented in <a class="el" href="classcore_1_1TLSSession.html#a8e26fdc9e8a6c573b5a504a1f1b137a9">core::TLSSession</a>.</p>
</div>
</div>
<a id="a50037cbfc515650e04054e5481785981"></a>
@@ -414,7 +385,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</tr>
</table>
</div><div class="memdoc">
<p>The output method is called by a socket session (BMASession) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list. </p>
<p>The output method is called by a socket session (<a class="el" href="classcore_1_1TCPSession.html">TCPSession</a>) and will output the detail information for the client socket. When extending BMATCPSocket or BMASession you can override the method to add attributes to the list. </p>
<p>Reimplemented from <a class="el" href="classcore_1_1TCPSocket.html#afacf7528ff3c9ac077d7b5a49e2116fd">core::TCPSocket</a>.</p>
@@ -507,8 +478,8 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</div>
</div>
<a id="afde7a264edac9e91b509f13eb4192038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afde7a264edac9e91b509f13eb4192038">&#9670;&nbsp;</a></span>setMode()</h2>
<a id="a836fb3fd5ee543ebc93262a980ae88b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a836fb3fd5ee543ebc93262a980ae88b5">&#9670;&nbsp;</a></span>setBlockSize()</h2>
<div class="memitem">
<div class="memproto">
@@ -517,21 +488,11 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void core::TCPSession::setMode </td>
<td class="memname">void core::TCPSession::setBlockSize </td>
<td>(</td>
<td class="paramtype">core::Mode&#160;</td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td class="paramname"><em>size</em> = <code>0</code></td><td>)</td>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
@@ -540,7 +501,7 @@ bool&#160;</td><td class="memItemRight" valign="bottom"><b>shutDown</b> = false<
</tr>
</table>
</div><div class="memdoc">
<p>Use the setMode method to set the receiving mode for the data on this socket. Data can be received in LINE mode, which will receive data from the socket one line at a time, or BLOCK mode where a certain specified data block is received before calling the onBlockReceived method. </p>
<p>Use setBlockSize to set the amount of data that should be read at once from the session data buffer. If this value is set to 0 then the data will be retrieved </p>
</div>
</div>