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

New build.

Browse Source
This commit is contained in:
barant committed 2020-04-13 09:40:58 -07:00
1 parent a5a51f8aae
commit b4ab5fb86a
835 files changed
+26499 -3119
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

html/classcore_1_1EPoll.html
+43 -28
View File
@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!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.8.13"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: core::EPoll Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,18 +29,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -77,8 +80,9 @@ Inheritance diagram for core::EPoll:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1EPoll__inherit__graph.png" border="0" usemap="#core_1_1EPoll_inherit__map" alt="Inheritance graph"/></div>
<map name="core_1_1EPoll_inherit__map" id="core_1_1EPoll_inherit__map">
<area shape="rect" id="node2" href="classcore_1_1Command.html" title="core::Command" alt="" coords="5,80,120,107"/>
<area shape="rect" id="node3" href="classcore_1_1Object.html" title="core::Object" alt="" coords="16,5,109,32"/>
<area shape="rect" title=" " alt="" coords="19,155,106,181"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="5,80,120,107"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="16,5,109,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
@@ -86,8 +90,9 @@ Collaboration diagram for core::EPoll:</div>
<div class="dyncontent">
<div class="center"><img src="classcore_1_1EPoll__coll__graph.png" border="0" usemap="#core_1_1EPoll_coll__map" alt="Collaboration graph"/></div>
<map name="core_1_1EPoll_coll__map" id="core_1_1EPoll_coll__map">
<area shape="rect" id="node2" href="classcore_1_1Command.html" title="core::Command" alt="" coords="5,80,120,107"/>
<area shape="rect" id="node3" href="classcore_1_1Object.html" title="core::Object" alt="" coords="16,5,109,32"/>
<area shape="rect" title=" " alt="" coords="19,155,106,181"/>
<area shape="rect" href="classcore_1_1Command.html" title=" " alt="" coords="5,80,120,107"/>
<area shape="rect" href="classcore_1_1Object.html" title=" " alt="" coords="16,5,109,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
@@ -98,28 +103,28 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a8e7a2496d684b745a6410f9bd3e88534"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a8e7a2496d684b745a6410f9bd3e88534">~EPoll</a> ()</td></tr>
<tr class="separator:a8e7a2496d684b745a6410f9bd3e88534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaefe2caef75eb538af90cb34682d277b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#aaefe2caef75eb538af90cb34682d277b">start</a> (int numberOfThreads, int <a class="el" href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90">maxSockets</a>)</td></tr>
<tr class="memdesc:aaefe2caef75eb538af90cb34682d277b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the BMAEPoll processing. <a href="#aaefe2caef75eb538af90cb34682d277b">More...</a><br /></td></tr>
<tr class="memdesc:aaefe2caef75eb538af90cb34682d277b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the BMAEPoll processing. <a href="classcore_1_1EPoll.html#aaefe2caef75eb538af90cb34682d277b">More...</a><br /></td></tr>
<tr class="separator:aaefe2caef75eb538af90cb34682d277b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c2865acd31d14fbf19dbc42cc084ddc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc">stop</a> ()</td></tr>
<tr class="memdesc:a0c2865acd31d14fbf19dbc42cc084ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop and shut down the BMAEPoll processing. <a href="#a0c2865acd31d14fbf19dbc42cc084ddc">More...</a><br /></td></tr>
<tr class="memdesc:a0c2865acd31d14fbf19dbc42cc084ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop and shut down the BMAEPoll processing. <a href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc">More...</a><br /></td></tr>
<tr class="separator:a0c2865acd31d14fbf19dbc42cc084ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a301b46b71ac7ac61a687ff723fe269b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a301b46b71ac7ac61a687ff723fe269b3">isStopping</a> ()</td></tr>
<tr class="memdesc:a301b46b71ac7ac61a687ff723fe269b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a true if the stop command has been requested. <a href="#a301b46b71ac7ac61a687ff723fe269b3">More...</a><br /></td></tr>
<tr class="memdesc:a301b46b71ac7ac61a687ff723fe269b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a true if the stop command has been requested. <a href="classcore_1_1EPoll.html#a301b46b71ac7ac61a687ff723fe269b3">More...</a><br /></td></tr>
<tr class="separator:a301b46b71ac7ac61a687ff723fe269b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d813c7bbf0da70ebc8e3cb6aeeacfb4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a3d813c7bbf0da70ebc8e3cb6aeeacfb4">registerSocket</a> (<a class="el" href="classcore_1_1Socket.html">Socket</a> *socket)</td></tr>
<tr class="memdesc:a3d813c7bbf0da70ebc8e3cb6aeeacfb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a BMASocket for monitoring by BMAEPoll. <a href="#a3d813c7bbf0da70ebc8e3cb6aeeacfb4">More...</a><br /></td></tr>
<tr class="memdesc:a3d813c7bbf0da70ebc8e3cb6aeeacfb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a BMASocket for monitoring by BMAEPoll. <a href="classcore_1_1EPoll.html#a3d813c7bbf0da70ebc8e3cb6aeeacfb4">More...</a><br /></td></tr>
<tr class="separator:a3d813c7bbf0da70ebc8e3cb6aeeacfb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ab5e82ab51e0952fc8fbcc128f52900"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a5ab5e82ab51e0952fc8fbcc128f52900">unregisterSocket</a> (<a class="el" href="classcore_1_1Socket.html">Socket</a> *socket)</td></tr>
<tr class="memdesc:a5ab5e82ab51e0952fc8fbcc128f52900"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister a BMASocket from monitoring by BMAEPoll. <a href="#a5ab5e82ab51e0952fc8fbcc128f52900">More...</a><br /></td></tr>
<tr class="memdesc:a5ab5e82ab51e0952fc8fbcc128f52900"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister a BMASocket from monitoring by BMAEPoll. <a href="classcore_1_1EPoll.html#a5ab5e82ab51e0952fc8fbcc128f52900">More...</a><br /></td></tr>
<tr class="separator:a5ab5e82ab51e0952fc8fbcc128f52900"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e52017e1deae15c1c87c6b6a099e1ed"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a1e52017e1deae15c1c87c6b6a099e1ed">getDescriptor</a> ()</td></tr>
<tr class="memdesc:a1e52017e1deae15c1c87c6b6a099e1ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the descriptor for the ePoll socket. <a href="#a1e52017e1deae15c1c87c6b6a099e1ed">More...</a><br /></td></tr>
<tr class="memdesc:a1e52017e1deae15c1c87c6b6a099e1ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the descriptor for the ePoll socket. <a href="classcore_1_1EPoll.html#a1e52017e1deae15c1c87c6b6a099e1ed">More...</a><br /></td></tr>
<tr class="separator:a1e52017e1deae15c1c87c6b6a099e1ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3238b150b5d0a57eb2e1b17daa236d3b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a3238b150b5d0a57eb2e1b17daa236d3b">eventReceived</a> (struct epoll_event event)</td></tr>
<tr class="memdesc:a3238b150b5d0a57eb2e1b17daa236d3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch event to appropriate socket. <a href="#a3238b150b5d0a57eb2e1b17daa236d3b">More...</a><br /></td></tr>
<tr class="separator:a3238b150b5d0a57eb2e1b17daa236d3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39b88c943190f724c963b49baaa2cfbb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a39b88c943190f724c963b49baaa2cfbb">eventReceived</a> (struct epoll_event event, pid_t threadId)</td></tr>
<tr class="memdesc:a39b88c943190f724c963b49baaa2cfbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch event to appropriate socket. <a href="classcore_1_1EPoll.html#a39b88c943190f724c963b49baaa2cfbb">More...</a><br /></td></tr>
<tr class="separator:a39b88c943190f724c963b49baaa2cfbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c2d7fdaec43d0a15abab0399d5727df"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df">processCommand</a> (std::string command, <a class="el" href="classcore_1_1TCPSession.html">TCPSession</a> *session, std::stringstream &amp;data) override</td></tr>
<tr class="memdesc:a0c2d7fdaec43d0a15abab0399d5727df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output the threads array to the console. <a href="#a0c2d7fdaec43d0a15abab0399d5727df">More...</a><br /></td></tr>
<tr class="memdesc:a0c2d7fdaec43d0a15abab0399d5727df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output the threads array to the console. <a href="classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df">More...</a><br /></td></tr>
<tr class="separator:a0c2d7fdaec43d0a15abab0399d5727df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a033633714311f3edc4127ddd1c37f299"><td class="memItemLeft" align="right" valign="top"><a id="a033633714311f3edc4127ddd1c37f299"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>resetSocket</b> (<a class="el" href="classcore_1_1Socket.html">Socket</a> *socket)</td></tr>
@@ -138,7 +143,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>getName</b> ()
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acfcef2513d94f7b9a191fed3dc744d90"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90">maxSockets</a></td></tr>
<tr class="memdesc:acfcef2513d94f7b9a191fed3dc744d90"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of socket allowed. <a href="#acfcef2513d94f7b9a191fed3dc744d90">More...</a><br /></td></tr>
<tr class="memdesc:acfcef2513d94f7b9a191fed3dc744d90"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum number of socket allowed. <a href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90">More...</a><br /></td></tr>
<tr class="separator:acfcef2513d94f7b9a191fed3dc744d90"><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>
@@ -152,7 +157,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
<div class="textblock"><p><a class="el" href="classcore_1_1EPoll.html">EPoll</a></p>
<p>Manage socket events from the epoll system call.</p>
<p>Use this object to establish a socket server using the epoll network structure of Linux.</p>
<p>Use this object to establish the basis of working with multiple sockets of all sorts using the epoll capabilities of the Linux platform. <a class="el" href="classcore_1_1Socket.html">Socket</a> objects can register with BMAEPoll which will establish a communication mechanism with that socket.</p>
<p>Use this object to establish the basis of working with multiple sockets of all sorts using the epoll capabilities of the Linux platform. <a class="el" href="classcore_1_1Socket.html">Socket</a> objects can register with <a class="el" href="classcore_1_1EPoll.html">EPoll</a> which will establish a communication mechanism with that socket.</p>
<p>The maximum number of sockets to communicate with is specified on the start method.</p>
<p>Threads are used to establish a read queue for epoll. The desired number of threads (or queues) is established by a parameter on the start method. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
@@ -193,8 +198,8 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3238b150b5d0a57eb2e1b17daa236d3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3238b150b5d0a57eb2e1b17daa236d3b">&#9670;&nbsp;</a></span>eventReceived()</h2>
<a id="a39b88c943190f724c963b49baaa2cfbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39b88c943190f724c963b49baaa2cfbb">&#9670;&nbsp;</a></span>eventReceived()</h2>
<div class="memitem">
<div class="memproto">
@@ -203,8 +208,18 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
<td class="memname">void core::EPoll::eventReceived </td>
<td>(</td>
<td class="paramtype">struct epoll_event&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">pid_t&#160;</td>
<td class="paramname"><em>threadId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
@@ -250,7 +265,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
</div><div class="memdoc">
<p>Returns a true if the stop command has been requested. </p>
<p>This method returns a true if the <a class="el" href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc" title="Stop and shut down the BMAEPoll processing. ">stop()</a> method has been called and the epoll system is shutting. </p>
<p>This method returns a true if the <a class="el" href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc" title="Stop and shut down the BMAEPoll processing.">stop()</a> method has been called and the epoll system is shutting. </p>
</div>
</div>
@@ -295,7 +310,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
</div><div class="memdoc">
<p>Output the threads array to the console. </p>
<p>The <a class="el" href="classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df" title="Output the threads array to the console. ">processCommand()</a> method displays the thread array to the requesting console via the session passed as parameter.</p>
<p>The <a class="el" href="classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df" title="Output the threads array to the console.">processCommand()</a> method displays the thread array to the requesting console via the session passed as parameter.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session to write the requested data to. </td></tr>
@@ -362,7 +377,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
</div><div class="memdoc">
<p>Start the BMAEPoll processing. </p>
<p>Use the <a class="el" href="classcore_1_1EPoll.html#aaefe2caef75eb538af90cb34682d277b" title="Start the BMAEPoll processing. ">start()</a> method to initiate the threads and begin epoll queue processing.</p>
<p>Use the <a class="el" href="classcore_1_1EPoll.html#aaefe2caef75eb538af90cb34682d277b" title="Start the BMAEPoll processing.">start()</a> method to initiate the threads and begin epoll queue processing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numberOfThreads</td><td>the number of threads to start for processing epoll entries. </td></tr>
@@ -389,7 +404,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
</div><div class="memdoc">
<p>Stop and shut down the BMAEPoll processing. </p>
<p>Use the <a class="el" href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc" title="Stop and shut down the BMAEPoll processing. ">stop()</a> method to initiate the shutdown process for the epoll socket management.</p>
<p>Use the <a class="el" href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc" title="Stop and shut down the BMAEPoll processing.">stop()</a> method to initiate the shutdown process for the epoll socket management.</p>
<p>A complete shutdown of all managed sockets will be initiated by this method call. </p>
</div>
@@ -448,7 +463,7 @@ std::string&#160;</td><td class="memItemRight" valign="bottom"><b>tag</b></td></
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</a> 1.8.17
</small></address>
</body>
</html>