ServerCore/html/EPoll_8h_source.html

158 lines
17 KiB
HTML

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: EPoll.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">EPoll.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __EPoll_h__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __EPoll_h__</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;Log.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;Socket.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;Thread.h&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;TCPSession.h&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;Command.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span>core {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classcore_1_1EPoll.html"> 31</a></span>&#160; <span class="keyword">class </span><a class="code" href="classcore_1_1EPoll.html">EPoll</a> : <span class="keyword">public</span> <a class="code" href="classcore_1_1Command.html">Command</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">public</span>: </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classcore_1_1EPoll.html#a2fd5cc4336b5f72990ecc0e7ea3d7641">EPoll</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classcore_1_1EPoll.html#a8e7a2496d684b745a6410f9bd3e88534">~EPoll</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1EPoll.html#aaefe2caef75eb538af90cb34682d277b">start</a>(<span class="keywordtype">int</span> numberOfThreads, <span class="keywordtype">int</span> <a class="code" href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90">maxSockets</a>); </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc">stop</a>(); </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1EPoll.html#a301b46b71ac7ac61a687ff723fe269b3">isStopping</a>(); </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1EPoll.html#a3d813c7bbf0da70ebc8e3cb6aeeacfb4">registerSocket</a>(<a class="code" href="classcore_1_1Socket.html">Socket</a> *socket); </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1EPoll.html#a5ab5e82ab51e0952fc8fbcc128f52900">unregisterSocket</a>(<a class="code" href="classcore_1_1Socket.html">Socket</a> *socket); </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classcore_1_1EPoll.html#a1e52017e1deae15c1c87c6b6a099e1ed">getDescriptor</a>(); </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90"> 98</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90">maxSockets</a>; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classcore_1_1EPoll.html#a3238b150b5d0a57eb2e1b17daa236d3b">eventReceived</a>(<span class="keyword">struct</span> epoll_event event); </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df">processCommand</a>(std::string command, <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> *session, std::stringstream &amp;data) <span class="keyword">override</span>; </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordtype">void</span> resetSocket(<a class="code" href="classcore_1_1Socket.html">Socket</a> *socket);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordtype">int</span> epfd;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordtype">int</span> numberOfThreads; </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; std::vector&lt;Thread&gt; threads; </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">volatile</span> <span class="keywordtype">bool</span> terminateThreads; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">void</span> enableSocket(<a class="code" href="classcore_1_1Socket.html">Socket</a> *socket);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">void</span> disableSocket(<a class="code" href="classcore_1_1Socket.html">Socket</a> *socket);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; };</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;}</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclasscore_1_1EPoll_html_a301b46b71ac7ac61a687ff723fe269b3"><div class="ttname"><a href="classcore_1_1EPoll.html#a301b46b71ac7ac61a687ff723fe269b3">core::EPoll::isStopping</a></div><div class="ttdeci">bool isStopping()</div><div class="ttdoc">Returns a true if the stop command has been requested.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:67</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_aaefe2caef75eb538af90cb34682d277b"><div class="ttname"><a href="classcore_1_1EPoll.html#aaefe2caef75eb538af90cb34682d277b">core::EPoll::start</a></div><div class="ttdeci">bool start(int numberOfThreads, int maxSockets)</div><div class="ttdoc">Start the BMAEPoll processing.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:21</div></div>
<div class="ttc" id="aclasscore_1_1TCPSession_html"><div class="ttname"><a href="classcore_1_1TCPSession.html">core::TCPSession</a></div><div class="ttdef"><b>Definition:</b> TCPSession.h:24</div></div>
<div class="ttc" id="aclasscore_1_1Socket_html"><div class="ttname"><a href="classcore_1_1Socket.html">core::Socket</a></div><div class="ttdef"><b>Definition:</b> Socket.h:33</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a5ab5e82ab51e0952fc8fbcc128f52900"><div class="ttname"><a href="classcore_1_1EPoll.html#a5ab5e82ab51e0952fc8fbcc128f52900">core::EPoll::unregisterSocket</a></div><div class="ttdeci">bool unregisterSocket(Socket *socket)</div><div class="ttdoc">Unregister a BMASocket from monitoring by BMAEPoll.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:77</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html"><div class="ttname"><a href="classcore_1_1EPoll.html">core::EPoll</a></div><div class="ttdef"><b>Definition:</b> EPoll.h:31</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a0c2865acd31d14fbf19dbc42cc084ddc"><div class="ttname"><a href="classcore_1_1EPoll.html#a0c2865acd31d14fbf19dbc42cc084ddc">core::EPoll::stop</a></div><div class="ttdeci">bool stop()</div><div class="ttdoc">Stop and shut down the BMAEPoll processing.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:47</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_acfcef2513d94f7b9a191fed3dc744d90"><div class="ttname"><a href="classcore_1_1EPoll.html#acfcef2513d94f7b9a191fed3dc744d90">core::EPoll::maxSockets</a></div><div class="ttdeci">int maxSockets</div><div class="ttdoc">The maximum number of socket allowed.</div><div class="ttdef"><b>Definition:</b> EPoll.h:98</div></div>
<div class="ttc" id="aclasscore_1_1Command_html"><div class="ttname"><a href="classcore_1_1Command.html">core::Command</a></div><div class="ttdef"><b>Definition:</b> Command.h:22</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a3238b150b5d0a57eb2e1b17daa236d3b"><div class="ttname"><a href="classcore_1_1EPoll.html#a3238b150b5d0a57eb2e1b17daa236d3b">core::EPoll::eventReceived</a></div><div class="ttdeci">void eventReceived(struct epoll_event event)</div><div class="ttdoc">Dispatch event to appropriate socket.</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a1e52017e1deae15c1c87c6b6a099e1ed"><div class="ttname"><a href="classcore_1_1EPoll.html#a1e52017e1deae15c1c87c6b6a099e1ed">core::EPoll::getDescriptor</a></div><div class="ttdeci">int getDescriptor()</div><div class="ttdoc">Return the descriptor for the ePoll socket.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:83</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a0c2d7fdaec43d0a15abab0399d5727df"><div class="ttname"><a href="classcore_1_1EPoll.html#a0c2d7fdaec43d0a15abab0399d5727df">core::EPoll::processCommand</a></div><div class="ttdeci">int processCommand(std::string command, TCPSession *session, std::stringstream &amp;data) override</div><div class="ttdoc">Output the threads array to the console.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:87</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a8e7a2496d684b745a6410f9bd3e88534"><div class="ttname"><a href="classcore_1_1EPoll.html#a8e7a2496d684b745a6410f9bd3e88534">core::EPoll::~EPoll</a></div><div class="ttdeci">~EPoll()</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:17</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a2fd5cc4336b5f72990ecc0e7ea3d7641"><div class="ttname"><a href="classcore_1_1EPoll.html#a2fd5cc4336b5f72990ecc0e7ea3d7641">core::EPoll::EPoll</a></div><div class="ttdeci">EPoll()</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:8</div></div>
<div class="ttc" id="aclasscore_1_1EPoll_html_a3d813c7bbf0da70ebc8e3cb6aeeacfb4"><div class="ttname"><a href="classcore_1_1EPoll.html#a3d813c7bbf0da70ebc8e3cb6aeeacfb4">core::EPoll::registerSocket</a></div><div class="ttdeci">bool registerSocket(Socket *socket)</div><div class="ttdoc">Register a BMASocket for monitoring by BMAEPoll.</div><div class="ttdef"><b>Definition:</b> EPoll.cpp:71</div></div>
<!-- start footer part -->
<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.17
</small></address>
</body>
</html>