enet/_tcp_8hpp_source.html

165 lines
24 KiB
HTML

<!-- HTML header for doxygen 1.8.8-->
<!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="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<title>enet: Ewol network abstraction: framework/atria-soft/enet/enet/Tcp.hpp Source File</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<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" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">enet: Ewol network abstraction 0.4.0</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="index.html">Main&nbsp;Page</a></li>
<li><a href="pages.html">Related&nbsp;Pages</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="annotated.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
Link-libs<span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
</ul>
</li>
</ul>
<div id="search-box" class="input-group">
<div class="input-group-btn">
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
<span class="glyphicon glyphicon-search"></span>
<span class="caret"></span>
</button>
<ul class="dropdown-menu">
<li><a href="#">All</a></li>
<li><a href="#">Classes</a></li>
<li><a href="#">Namespaces</a></li>
<li><a href="#">Files</a></li>
<li><a href="#">Functions</a></li>
<li><a href="#">Variables</a></li>
<li><a href="#">Typedefs</a></li>
<li><a href="#">Enumerations</a></li>
<li><a href="#">Enumerator</a></li>
<li><a href="#">Friends</a></li>
<li><a href="#">Macros</a></li>
<li><a href="#">Pages</a></li>
</ul>
</div>
<button id="search-close" type="button" class="close" aria-label="Close">
<span aria-hidden="true"></span>
</button>
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;margin-top: 60px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_644e041c3a6521da7b27eba0e4eb2b95.html">framework</a></li><li class="navelem"><a class="el" href="dir_a094892b17be858f66bf3446bbb755c7.html">atria-soft</a></li><li class="navelem"><a class="el" href="dir_f7835a0040178a7c3fe3e7c27f6d9084.html">enet</a></li><li class="navelem"><a class="el" href="dir_8df4c94f510f53f1374a2c2b5801aba9.html">enet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Tcp.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_tcp_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" doxygen="/home/heero/dev/perso/out/doc/release/etk.tag:http://atria-soft.github.io/etk/" href="http://atria-soft.github.io/etk/types__8hpp.html">etk/types.hpp</a>&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#ifdef __TARGET_OS__Windows</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor"> #include &lt;winsock2.h&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"> #include &lt;ws2tcpip.h&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceenet.html">enet</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classenet_1_1_tcp.html"> 16</a></span>&#160; <span class="keyword">class </span><a class="code" href="classenet_1_1_tcp.html">Tcp</a> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"> #ifdef __TARGET_OS__Windows</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; SOCKET m_socketId; </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor"> #else</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; int32_t m_socketId; </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor"> #endif</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; std::mutex m_mutex;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classenet_1_1_tcp.html">Tcp</a>();</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor"> #ifdef __TARGET_OS__Windows</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="classenet_1_1_tcp.html">Tcp</a>(SOCKET _idSocket, <span class="keyword">const</span> std::string&amp; _name);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor"> #else</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="classenet_1_1_tcp.html">Tcp</a>(int32_t _idSocket, <span class="keyword">const</span> std::string&amp; _name);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor"> #endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="comment">// move constructor</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classenet_1_1_tcp.html">Tcp</a>(<a class="code" href="classenet_1_1_tcp.html">Tcp</a>&amp;&amp; _obj);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// Move operator;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classenet_1_1_tcp.html">Tcp</a>&amp; operator= (<a class="code" href="classenet_1_1_tcp.html">Tcp</a>&amp;&amp; _obj);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// Remove copy operator ... ==&gt; not valid ...</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classenet_1_1_tcp.html">Tcp</a>&amp; operator= (<a class="code" href="classenet_1_1_tcp.html">Tcp</a>&amp; _obj) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classenet_1_1_tcp.html">Tcp</a>();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; std::string m_name; </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classenet_1_1_tcp.html#ad93fb9d484a0eecc2057deee10f445a1"> 45</a></span>&#160; <span class="keyword">const</span> std::string&amp; <a class="code" href="classenet_1_1_tcp.html#ad93fb9d484a0eecc2057deee10f445a1">getName</a>() {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> m_name;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">enum class</span> status {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; unlink,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; link,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; linkRemoteClose,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; error</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; };</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">enum</span> status m_status; </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classenet_1_1_tcp.html#adc1608c7f511678b50920688946a7be7"> 62</a></span>&#160; <span class="keyword">enum</span> status <a class="code" href="classenet_1_1_tcp.html#adc1608c7f511678b50920688946a7be7">getConnectionStatus</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">return</span> m_status;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">bool</span> unlink();</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; int32_t <a class="code" href="classenet_1_1_tcp.html#a39248e8a9d91624b3e7ffa15db7dc3d3">read</a>(<span class="keywordtype">void</span>* _data, int32_t _maxLen);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; int32_t <a class="code" href="classenet_1_1_tcp.html#a4fd69af7f485b679a9d53644070e78ac">write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* _data, int32_t _len);</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classenet_1_1_tcp.html#a4d6613d3adff8ffa30fdcd6d7ab4faf9"> 95</a></span>&#160; int32_t <a class="code" href="classenet_1_1_tcp.html#a4d6613d3adff8ffa30fdcd6d7ab4faf9">write</a>(<span class="keyword">const</span> std::string&amp; _data, <span class="keywordtype">bool</span> _writeBackSlashZero = <span class="keyword">true</span>) {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">if</span> (_data.size() == 0) {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">if</span> (_writeBackSlashZero == <span class="keyword">true</span>) {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classenet_1_1_tcp.html#a4fd69af7f485b679a9d53644070e78ac">write</a>(_data.c_str(), _data.size()+1);</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="keywordflow">return</span> <a class="code" href="classenet_1_1_tcp.html#a4fd69af7f485b679a9d53644070e78ac">write</a>(_data.c_str(), _data.size());</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classenet_1_1_tcp.html#a630f1853885c26ec868b4b8ac7d91372"> 112</a></span>&#160; int32_t <a class="code" href="classenet_1_1_tcp.html#a630f1853885c26ec868b4b8ac7d91372">write</a>(<span class="keyword">const</span> std::vector&lt;T&gt;&amp; _data) {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordflow">if</span> (_data.size() == 0) {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordflow">return</span> 0;</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"> 116</span>&#160; <span class="keywordtype">size_t</span> ret = <a class="code" href="classenet_1_1_tcp.html#a4fd69af7f485b679a9d53644070e78ac">write</a>(&amp;_data[0], _data.size()*<span class="keyword">sizeof</span>(T));</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span> (ret &lt;=0) {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; }</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keywordflow">return</span> ret/<span class="keyword">sizeof</span>(T);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">bool</span> setTCPNoDelay(<span class="keywordtype">bool</span> _enabled);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; };</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="ttc" id="types__8hpp_html"><div class="ttname"><a href="http://atria-soft.github.io/etk/types__8hpp.html">types.hpp</a></div></div>
<div class="ttc" id="classenet_1_1_tcp_html_ad93fb9d484a0eecc2057deee10f445a1"><div class="ttname"><a href="classenet_1_1_tcp.html#ad93fb9d484a0eecc2057deee10f445a1">enet::Tcp::getName</a></div><div class="ttdeci">const std::string &amp; getName()</div><div class="ttdoc">Get the decriptive name hot the host:port. </div><div class="ttdef"><b>Definition:</b> Tcp.hpp:45</div></div>
<div class="ttc" id="classenet_1_1_tcp_html_a630f1853885c26ec868b4b8ac7d91372"><div class="ttname"><a href="classenet_1_1_tcp.html#a630f1853885c26ec868b4b8ac7d91372">enet::Tcp::write</a></div><div class="ttdeci">int32_t write(const std::vector&lt; T &gt; &amp;_data)</div><div class="ttdoc">Write a chunk of data on the socket. </div><div class="ttdef"><b>Definition:</b> Tcp.hpp:112</div></div>
<div class="ttc" id="classenet_1_1_tcp_html_adc1608c7f511678b50920688946a7be7"><div class="ttname"><a href="classenet_1_1_tcp.html#adc1608c7f511678b50920688946a7be7">enet::Tcp::getConnectionStatus</a></div><div class="ttdeci">enum status getConnectionStatus() const</div><div class="ttdoc">Get the current Status of the connection. </div><div class="ttdef"><b>Definition:</b> Tcp.hpp:62</div></div>
<div class="ttc" id="classenet_1_1_tcp_html_a4d6613d3adff8ffa30fdcd6d7ab4faf9"><div class="ttname"><a href="classenet_1_1_tcp.html#a4d6613d3adff8ffa30fdcd6d7ab4faf9">enet::Tcp::write</a></div><div class="ttdeci">int32_t write(const std::string &amp;_data, bool _writeBackSlashZero=true)</div><div class="ttdoc">Write a chunk of data on the socket. </div><div class="ttdef"><b>Definition:</b> Tcp.hpp:95</div></div>
<div class="ttc" id="classenet_1_1_tcp_html_a4fd69af7f485b679a9d53644070e78ac"><div class="ttname"><a href="classenet_1_1_tcp.html#a4fd69af7f485b679a9d53644070e78ac">enet::Tcp::write</a></div><div class="ttdeci">int32_t write(const void *_data, int32_t _len)</div><div class="ttdoc">Write a chunk of data on the socket. </div></div>
<div class="ttc" id="classenet_1_1_tcp_html_a39248e8a9d91624b3e7ffa15db7dc3d3"><div class="ttname"><a href="classenet_1_1_tcp.html#a39248e8a9d91624b3e7ffa15db7dc3d3">enet::Tcp::read</a></div><div class="ttdeci">int32_t read(void *_data, int32_t _maxLen)</div><div class="ttdoc">Read a chunk of data on the socket. </div></div>
<div class="ttc" id="classenet_1_1_tcp_html"><div class="ttname"><a href="classenet_1_1_tcp.html">enet::Tcp</a></div><div class="ttdef"><b>Definition:</b> Tcp.hpp:16</div></div>
<div class="ttc" id="namespaceenet_html"><div class="ttname"><a href="namespaceenet.html">enet</a></div><div class="ttdoc">Main esvg namespace. </div><div class="ttdef"><b>Definition:</b> enet.hpp:17</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.8-->
<!-- start footer part -->
</div>
</div>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 24 2016 15:35:53 for enet: Ewol network abstraction by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>