87 lines
23 KiB
HTML
87 lines
23 KiB
HTML
<!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>My Project: 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">My Project
|
|
</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">Socket.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __Socket_h__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __Socket_h__</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "includes"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "Object.h"</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  <span class="keyword">class </span>EPoll;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classcore_1_1Socket.html"> 32</a></span>  <span class="keyword">class </span><a class="code" href="classcore_1_1Socket.html">Socket</a> : <span class="keyword">public</span> <a class="code" href="classcore_1_1Object.html">core::Object</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classcore_1_1Socket.html">Socket</a>(<a class="code" href="classcore_1_1EPoll.html">EPoll</a> &ePoll);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classcore_1_1Socket.html">Socket</a>(<a class="code" href="classcore_1_1EPoll.html">EPoll</a> &ePoll, std::string text);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ~<a class="code" href="classcore_1_1Socket.html">Socket</a>();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31">shutdown</a>(std::string text = <span class="stringliteral">"unknown"</span>);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#ac44f6ae3196a8a3e09a6a85fcf495762">setDescriptor</a>(<span class="keywordtype">int</span> descriptor); </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> <a class="code" href="classcore_1_1Socket.html#a06ba54744530439d4131e6aba4623d08">getDescriptor</a>(); </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">class </span>{</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">int</span> value;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">int</span> & operator = (<span class="keyword">const</span> <span class="keywordtype">int</span> &i) { <span class="keywordflow">return</span> value = i; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">operator</span> int ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> value; }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  } bufferSize; </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> <a class="code" href="classcore_1_1Socket.html#a4c9a3396693ff919eb827729f9e72b03">eventReceived</a>(<span class="keyword">struct</span> epoll_event event); </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">int</span> <a class="code" href="classcore_1_1Socket.html#a1413c826307ef0f29d7457770af675e3">write</a>(std::string data);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#a1413c826307ef0f29d7457770af675e3">write</a>(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> length);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> output(std::stringstream &out);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0">onRegister</a>(); </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> onRegistered();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#aa1d380db54a5b2efbc859e3744bd898b">onUnregister</a>(); </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">bool</span> needsToWrite();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">bool</span> active = <span class="keyword">false</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classcore_1_1EPoll.html">EPoll</a> &ePoll; <span class="comment">// The EPoll control object.</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">bool</span> shutDown = <span class="keyword">false</span>;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> setBufferSize(<span class="keywordtype">int</span> length);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// virtual void onConnected(); ///< Called when socket is open and ready to communicate.</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment">// virtual void onDisconnected(); ///< Called when socket is closing and no longer ready to communicate.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">onDataReceived</a>(std::string data); </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">onDataReceived</a>(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> len); </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcore_1_1Socket.html#af455ec6f793473f529507af26aa54695">receiveData</a>(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> bufferLength);</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  std::string text;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">int</span> descriptor = -1;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  std::mutex lock;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  std::mutex socketLock;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">bool</span> readHangup = <span class="keyword">false</span>;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment">// struct epoll_event event; // Event selection construction structure.</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="comment">//-------------------------------------------------------------------------------------</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="comment">// the writeSocket is called when epoll has received a write request for a socket. </span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="comment">// Writing data to this socket is queued in the streambuf and permission is requested</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="comment">// to write to the socket. This routine handles the writing of the streambuf data</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="comment">// buffer to the socket.</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="comment">//------------------------------------------------------------------------------------- </span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordtype">void</span> writeSocket();</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="comment">// int_type underflow();</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">// int_type uflow();</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment">// int_type pbackfail(int_type ch);</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment">// streamsize showmanyc();</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">char</span> *buffer; <span class="comment">// This is a pointer to the managed buffer space.</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">int</span> length; <span class="comment">// This is the length of the buffer.</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment">// const char * const begin_;</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">// const char * const end_;</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">// const char * const current_;</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  std::queue<std::string> fifo;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  };</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> }</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </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_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="classcore_1_1Socket_html"><div class="ttname"><a href="classcore_1_1Socket.html">core::Socket</a></div><div class="ttdef"><b>Definition:</b> Socket.h:32</div></div>
|
|
<div class="ttc" id="classcore_1_1Object_html"><div class="ttname"><a href="classcore_1_1Object.html">core::Object</a></div><div class="ttdef"><b>Definition:</b> Object.h:8</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_a81e5ee3e17834166d97c6e8b7dfe0da0"><div class="ttname"><a href="classcore_1_1Socket.html#a81e5ee3e17834166d97c6e8b7dfe0da0">core::Socket::onRegister</a></div><div class="ttdeci">virtual void onRegister()</div><div class="ttdoc">Called when the socket has finished registering with the epoll processing. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:57</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_af455ec6f793473f529507af26aa54695"><div class="ttname"><a href="classcore_1_1Socket.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:107</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_a1413c826307ef0f29d7457770af675e3"><div class="ttname"><a href="classcore_1_1Socket.html#a1413c826307ef0f29d7457770af675e3">core::Socket::write</a></div><div class="ttdeci">int write(std::string data)</div><div class="ttdef"><b>Definition:</b> Socket.cpp:154</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_a4c9a3396693ff919eb827729f9e72b03"><div class="ttname"><a href="classcore_1_1Socket.html#a4c9a3396693ff919eb827729f9e72b03">core::Socket::eventReceived</a></div><div class="ttdeci">bool 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:63</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_ac8d6a2c54696eb6fc2024cf6bcf6b4e5"><div class="ttname"><a href="classcore_1_1Socket.html#ac8d6a2c54696eb6fc2024cf6bcf6b4e5">core::Socket::onDataReceived</a></div><div class="ttdeci">virtual void onDataReceived(std::string data)</div><div class="ttdoc">Called when data is received from the socket. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:99</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_ac44f6ae3196a8a3e09a6a85fcf495762"><div class="ttname"><a href="classcore_1_1Socket.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:32</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_a06ba54744530439d4131e6aba4623d08"><div class="ttname"><a href="classcore_1_1Socket.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:48</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_aa1d380db54a5b2efbc859e3744bd898b"><div class="ttname"><a href="classcore_1_1Socket.html#aa1d380db54a5b2efbc859e3744bd898b">core::Socket::onUnregister</a></div><div class="ttdeci">virtual void onUnregister()</div><div class="ttdoc">Called when the socket has finished unregistering for the epoll processing. </div><div class="ttdef"><b>Definition:</b> Socket.cpp:61</div></div>
|
|
<div class="ttc" id="classcore_1_1Socket_html_af2d1b6de7a64a9d446b0305b6ec47b31"><div class="ttname"><a href="classcore_1_1Socket.html#af2d1b6de7a64a9d446b0305b6ec47b31">core::Socket::shutdown</a></div><div class="ttdeci">void shutdown(std::string text="unknown")</div><div class="ttdef"><b>Definition:</b> Socket.cpp:175</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|