ServerCore/html/TCPServer_8h_source.html
2022-02-14 07:12:19 -08:00

172 lines
20 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: TCPServer.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">TCPServer.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 __TCPServer_h__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __TCPServer_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;Socket.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;TCPSocket.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;IPAddressList.h&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;Command.h&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;CommandList.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;SubscriptionManager.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span>core {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classcore_1_1TCPServer.html"> 25</a></span>&#160; <span class="keyword">class </span><a class="code" href="classcore_1_1TCPServer.html">TCPServer</a> : <span class="keyword">public</span> <a class="code" href="classcore_1_1TCPSocket.html">TCPSocket</a>, <span class="keyword">public</span> <a class="code" href="classcore_1_1Command.html">Command</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classcore_1_1TCPServer.html#abaecb97c336b757d1029d45277f9fc5b">TCPServer</a>(<a class="code" href="classcore_1_1EPoll.html">EPoll</a> &amp;ePoll, <a class="code" href="classcore_1_1IPAddress.html">IPAddress</a> address, std::string delimiter = <span class="stringliteral">&quot; &quot;</span>, <span class="keywordtype">int</span> depth = 10, std::string text = <span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classcore_1_1TCPServer.html#a7ccdc057c9eee8504fce796301f82088">~TCPServer</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> sessionErrorHandler(std::string errorString, std::stringstream &amp;out);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> * <a class="code" href="classcore_1_1TCPServer.html#a841f02799ad8529aad7cea132f4de8a9">getSocketAccept</a>(<a class="code" href="classcore_1_1EPoll.html">EPoll</a> &amp;epoll);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</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"><a class="line" href="classcore_1_1TCPServer.html#aeed1bc55d099667ccda51cd682bfc633"> 62</a></span>&#160; std::vector&lt;TCPSession *&gt; <a class="code" href="classcore_1_1TCPServer.html#aeed1bc55d099667ccda51cd682bfc633">sessions</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"><a class="line" href="classcore_1_1TCPServer.html#afcc44802b988e2f4292504e804dccf8b"> 69</a></span>&#160; <a class="code" href="classcore_1_1CommandList.html">CommandList</a> <a class="code" href="classcore_1_1TCPServer.html#afcc44802b988e2f4292504e804dccf8b">commands</a>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classcore_1_1TCPServer.html#a82f6bf16e4ab20d8b30da09e034fffff"> 77</a></span>&#160; <a class="code" href="classcore_1_1IPAddressList.html">IPAddressList</a> *<a class="code" href="classcore_1_1TCPServer.html#a82f6bf16e4ab20d8b30da09e034fffff">blackList</a>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classcore_1_1TCPServer.html#abad6300b6234ca8b69cef9128755342e"> 85</a></span>&#160; <a class="code" href="classcore_1_1IPAddressList.html">IPAddressList</a> *<a class="code" href="classcore_1_1TCPServer.html#abad6300b6234ca8b69cef9128755342e">whiteList</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> removeFromSessionList(<a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> *session);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classcore_1_1TCPServer.html#a49e3ead1bf4e7830685780e73c4db5db">output</a>(std::stringstream &amp;out); </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">void</span> sendToAll(std::stringstream &amp;out);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">void</span> sendToAll(std::stringstream &amp;out, <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;sender, <a class="code" href="classcore_1_1SessionFilter.html">SessionFilter</a> filter);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">void</span> sendToAll(std::stringstream &amp;out, <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;sender);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classcore_1_1TCPServer.html#a28302dd844cfc971ee41de2000d24aa0"> 116</a></span>&#160; <a class="code" href="classcore_1_1SubscriptionManager.html">SubscriptionManager</a> <a class="code" href="classcore_1_1TCPServer.html#a28302dd844cfc971ee41de2000d24aa0">subscriptions</a>;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</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="keywordtype">void</span> <a class="code" href="classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159">onDataReceived</a>(std::string data) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437">processCommand</a>(coreutils::ZString &amp;request, <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> &amp;session) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <a class="code" href="classcore_1_1TCPSession.html">TCPSession</a> * accept();</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; std::mutex lock;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; };</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;}</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclasscore_1_1TCPServer_html_a28302dd844cfc971ee41de2000d24aa0"><div class="ttname"><a href="classcore_1_1TCPServer.html#a28302dd844cfc971ee41de2000d24aa0">core::TCPServer::subscriptions</a></div><div class="ttdeci">SubscriptionManager subscriptions</div><div class="ttdef"><b>Definition:</b> TCPServer.h:116</div></div>
<div class="ttc" id="aclasscore_1_1SessionFilter_html"><div class="ttname"><a href="classcore_1_1SessionFilter.html">core::SessionFilter</a></div><div class="ttdef"><b>Definition:</b> SessionFilter.h:10</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_a82f6bf16e4ab20d8b30da09e034fffff"><div class="ttname"><a href="classcore_1_1TCPServer.html#a82f6bf16e4ab20d8b30da09e034fffff">core::TCPServer::blackList</a></div><div class="ttdeci">IPAddressList * blackList</div><div class="ttdef"><b>Definition:</b> TCPServer.h:77</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_1IPAddress_html"><div class="ttname"><a href="classcore_1_1IPAddress.html">core::IPAddress</a></div><div class="ttdef"><b>Definition:</b> IPAddress.h:9</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_aeed1bc55d099667ccda51cd682bfc633"><div class="ttname"><a href="classcore_1_1TCPServer.html#aeed1bc55d099667ccda51cd682bfc633">core::TCPServer::sessions</a></div><div class="ttdeci">std::vector&lt; TCPSession * &gt; sessions</div><div class="ttdef"><b>Definition:</b> TCPServer.h:62</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_a276ccbc8cb9b4380ebd78807b97f0159"><div class="ttname"><a href="classcore_1_1TCPServer.html#a276ccbc8cb9b4380ebd78807b97f0159">core::TCPServer::onDataReceived</a></div><div class="ttdeci">void onDataReceived(std::string data) override</div><div class="ttdef"><b>Definition:</b> TCPServer.cpp:36</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_1SubscriptionManager_html"><div class="ttname"><a href="classcore_1_1SubscriptionManager.html">core::SubscriptionManager</a></div><div class="ttdef"><b>Definition:</b> SubscriptionManager.h:13</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_a6b7a7e1ac4132942fcaf418ed41c1437"><div class="ttname"><a href="classcore_1_1TCPServer.html#a6b7a7e1ac4132942fcaf418ed41c1437">core::TCPServer::processCommand</a></div><div class="ttdeci">int processCommand(coreutils::ZString &amp;request, TCPSession &amp;session) override</div><div class="ttdef"><b>Definition:</b> TCPServer.cpp:90</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_abaecb97c336b757d1029d45277f9fc5b"><div class="ttname"><a href="classcore_1_1TCPServer.html#abaecb97c336b757d1029d45277f9fc5b">core::TCPServer::TCPServer</a></div><div class="ttdeci">TCPServer(EPoll &amp;ePoll, IPAddress address, std::string delimiter=&quot; &quot;, int depth=10, std::string text=&quot;&quot;)</div><div class="ttdef"><b>Definition:</b> TCPServer.cpp:9</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_1TCPSocket_html"><div class="ttname"><a href="classcore_1_1TCPSocket.html">core::TCPSocket</a></div><div class="ttdef"><b>Definition:</b> TCPSocket.h:20</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_abad6300b6234ca8b69cef9128755342e"><div class="ttname"><a href="classcore_1_1TCPServer.html#abad6300b6234ca8b69cef9128755342e">core::TCPServer::whiteList</a></div><div class="ttdeci">IPAddressList * whiteList</div><div class="ttdef"><b>Definition:</b> TCPServer.h:85</div></div>
<div class="ttc" id="aclasscore_1_1CommandList_html"><div class="ttname"><a href="classcore_1_1CommandList.html">core::CommandList</a></div><div class="ttdef"><b>Definition:</b> CommandList.h:18</div></div>
<div class="ttc" id="aclasscore_1_1IPAddressList_html"><div class="ttname"><a href="classcore_1_1IPAddressList.html">core::IPAddressList</a></div><div class="ttdef"><b>Definition:</b> IPAddressList.h:9</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_a7ccdc057c9eee8504fce796301f82088"><div class="ttname"><a href="classcore_1_1TCPServer.html#a7ccdc057c9eee8504fce796301f82088">core::TCPServer::~TCPServer</a></div><div class="ttdeci">virtual ~TCPServer()</div><div class="ttdef"><b>Definition:</b> TCPServer.cpp:31</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html"><div class="ttname"><a href="classcore_1_1TCPServer.html">core::TCPServer</a></div><div class="ttdef"><b>Definition:</b> TCPServer.h:25</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_afcc44802b988e2f4292504e804dccf8b"><div class="ttname"><a href="classcore_1_1TCPServer.html#afcc44802b988e2f4292504e804dccf8b">core::TCPServer::commands</a></div><div class="ttdeci">CommandList commands</div><div class="ttdef"><b>Definition:</b> TCPServer.h:69</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_a49e3ead1bf4e7830685780e73c4db5db"><div class="ttname"><a href="classcore_1_1TCPServer.html#a49e3ead1bf4e7830685780e73c4db5db">core::TCPServer::output</a></div><div class="ttdeci">void output(std::stringstream &amp;out)</div><div class="ttdoc">Output the consoles array to the console.</div><div class="ttdef"><b>Definition:</b> TCPServer.cpp:86</div></div>
<div class="ttc" id="aclasscore_1_1TCPServer_html_a841f02799ad8529aad7cea132f4de8a9"><div class="ttname"><a href="classcore_1_1TCPServer.html#a841f02799ad8529aad7cea132f4de8a9">core::TCPServer::getSocketAccept</a></div><div class="ttdeci">virtual TCPSession * getSocketAccept(EPoll &amp;epoll)</div><div class="ttdef"><b>Definition:</b> TCPServer.cpp:82</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>