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

Initial repository 1.0.0

Browse Source
This commit is contained in:
Brad Arant committed 2019-02-07 13:28:21 -08:00
commit d8b1275884
1861 files changed
+66342
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/html/_socket_8h_source.html
+87
View File
@@ -0,0 +1,87 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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="viewport" content="width=device-width, initial-scale=1"/>
<title>BMA Server Framework: /home/barant/Development/BMA/server_core/ServerCore/Socket.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">BMA Server Framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">/home/barant/Development/BMA/server_core/ServerCore/Socket.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 __Socket_h__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __Socket_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;includes&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;Object.h&quot;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacecore.html">core</a> {</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="keyword">class </span>EPoll;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classcore_1_1_socket.html"> 32</a></span>&#160; <span class="keyword">class </span><a class="code" href="classcore_1_1_socket.html">Socket</a> : <span class="keyword">public</span> std::streambuf,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">public</span> <a class="code" href="classcore_1_1_object.html">core::Object</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classcore_1_1_socket.html">Socket</a>(<a class="code" href="classcore_1_1_e_poll.html">EPoll</a> &amp;ePoll);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; ~<a class="code" href="classcore_1_1_socket.html">Socket</a>();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classcore_1_1_socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">setDescriptor</a>(<span class="keywordtype">int</span> descriptor); </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">int</span> <a class="code" href="classcore_1_1_socket.html#a06ba54744530439d4131e6aba4623d08">getDescriptor</a>(); </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">class </span>{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">int</span> value;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">int</span> &amp; operator = (<span class="keyword">const</span> <span class="keywordtype">int</span> &amp;i) { <span class="keywordflow">return</span> value = i; }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">operator</span> int ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> value; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; } bufferSize; </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classcore_1_1_socket.html#a651bd967a6655152f87b7dd44e880cb2">eventReceived</a>(<span class="keyword">struct</span> epoll_event event); </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00068"><Line truncated
<div class="ttc" id="classcore_1_1_socket_html_af455ec6f793473f529507af26aa54695"><div class="ttname"><a href="classcore_1_1_socket.html#af455ec6f793473f529507af26aa54695">core::Socket::receiveData</a></div><div class="ttdeci">virtual void receiveData(char *buffer, int bufferLength)</div><div class="ttdef"><b>Definition:</b> Socket.cpp:86</div></div>
<div class="ttc" id="classcore_1_1_socket_html_ae9be59697c2b2e5efb19aaae3ba943d2"><div class="ttname"><a href="classcore_1_1_socket.html#ae9be59697c2b2e5efb19aaae3ba943d2">core::Socket::onUnregistered</a></div><div class="ttdeci">virtual void onUnregistered()</div><div class="ttdoc">Called when the socket has finished unregistering for the epoll processing. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:44</div></div>
<div class="ttc" id="namespacecore_html"><div class="ttname"><a href="namespacecore.html">core</a></div><div class="ttdef"><b>Definition:</b> Command.cpp:4</div></div>
<div class="ttc" id="classcore_1_1_socket_html_a80b113c4105bb0c74f2e104b0feb90e4"><div class="ttname"><a href="classcore_1_1_socket.html#a80b113c4105bb0c74f2e104b0feb90e4">core::Socket::enable</a></div><div class="ttdeci">void enable(bool mode)</div><div class="ttdoc">Enable the socket to read or write based upon buffer. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:74</div></div>
<div class="ttc" id="classcore_1_1_socket_html_add22bdee877319a372db2fd707dc5a1c"><div class="ttname"><a href="classcore_1_1_socket.html#add22bdee877319a372db2fd707dc5a1c">core::Socket::onDataReceived</a></div><div class="ttdeci">virtual void onDataReceived(std::string data)=0</div><div class="ttdoc">Called when data is received from the socket. </div></div>
<div class="ttc" id="classcore_1_1_socket_html_ac44f6ae3196a8a3e09a6a85fcf495762"><div class="ttname"><a href="classcore_1_1_socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">core::Socket::setDescriptor</a></div><div class="ttdeci">void setDescriptor(int descriptor)</div><div class="ttdoc">Set the descriptor for the socket. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:21</div></div>
<div class="ttc" id="classcore_1_1_socket_html_a36ad0e990494d451c493e752dc2a2722"><div class="ttname"><a href="classcore_1_1_socket.html#a36ad0e990494d451c493e752dc2a2722">core::Socket::write</a></div><div class="ttdeci">void write(std::string data)</div><div class="ttdef"><b>Definition:</b> Socket.cpp:131</div></div>
<div class="ttc" id="classcore_1_1_socket_html"><div class="ttname"><a href="classcore_1_1_socket.html">core::Socket</a></div><div class="ttdef"><b>Definition:</b> Socket.h:32</div></div>
<div class="ttc" id="classcore_1_1_socket_html_a651bd967a6655152f87b7dd44e880cb2"><div class="ttname"><a href="classcore_1_1_socket.html#a651bd967a6655152f87b7dd44e880cb2">core::Socket::eventReceived</a></div><div class="ttdeci">void eventReceived(struct epoll_event event)</div><div class="ttdoc">Parse epoll event and call specified callbacks. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:48</div></div>
<div class="ttc" id="classcore_1_1_socket_html_a06ba54744530439d4131e6aba4623d08"><div class="ttname"><a href="classcore_1_1_socket.html#a06ba54744530439d4131e6aba4623d08">core::Socket::getDescriptor</a></div><div class="ttdeci">int getDescriptor()</div><div class="ttdoc">Get the descriptor for the socket. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:29</div></div>
<div class="ttc" id="classcore_1_1_socket_html_a23b9824653bbe4652a716acb828665b1"><div class="ttname"><a href="classcore_1_1_socket.html#a23b9824653bbe4652a716acb828665b1">core::Socket::onRegistered</a></div><div class="ttdeci">virtual void onRegistered()</div><div class="ttdoc">Called when the socket has finished registering with the epoll processing. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:40</div></div>
<div class="ttc" id="classcore_1_1_object_html"><div class="ttname"><a href="classcore_1_1_object.html">core::Object</a></div><div class="ttdef"><b>Definition:</b> Object.h:8</div></div>
<div class="ttc" id="classcore_1_1_socket_html_a96b8919a4b5580e389df810a4820e2e0"><div class="ttname"><a href="classcore_1_1_socket.html#a96b8919a4b5580e389df810a4820e2e0">core::Socket::onConnected</a></div><div class="ttdeci">virtual void onConnected()</div><div class="ttdoc">Called when socket is open and ready to communicate. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:118</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.13
</small></address>
</body>
</html>