atria-soft/enet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
enet/classenet_1_1_tcp.html

453 lines
22 KiB
HTML
Raw Blame History

<!-- 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: enet::Tcp Class Reference</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="namespaceenet.html">enet</a></li><li class="navelem"><a class="el" href="classenet_1_1_tcp.html">Tcp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classenet_1_1_tcp-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">enet::Tcp Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a763ed7c45843d811b0325e573dd8ad13"><td class="memItemLeft" align="right" valign="top"><a id="a763ed7c45843d811b0325e573dd8ad13"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>status</b> { <b>unlink</b>,
<b>link</b>,
<b>linkRemoteClose</b>,
<b>error</b>
}</td></tr>
<tr class="separator:a763ed7c45843d811b0325e573dd8ad13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a51352192f3772574d0a36a26d78570b6"><td class="memItemLeft" align="right" valign="top"><a id="a51352192f3772574d0a36a26d78570b6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Tcp</b> (int32_t _idSocket, const std::string &amp;_name)</td></tr>
<tr class="separator:a51352192f3772574d0a36a26d78570b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab779411d35d5a596f4bca7ed9835b3cf"><td class="memItemLeft" align="right" valign="top"><a id="ab779411d35d5a596f4bca7ed9835b3cf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Tcp</b> (<a class="el" href="classenet_1_1_tcp.html">Tcp</a> &amp;&amp;_obj)</td></tr>
<tr class="separator:ab779411d35d5a596f4bca7ed9835b3cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4a5848a3d4c2b0b37535bfe9539b35a"><td class="memItemLeft" align="right" valign="top"><a id="ae4a5848a3d4c2b0b37535bfe9539b35a"></a>
<a class="el" href="classenet_1_1_tcp.html">Tcp</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classenet_1_1_tcp.html">Tcp</a> &amp;&amp;_obj)</td></tr>
<tr class="separator:ae4a5848a3d4c2b0b37535bfe9539b35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f61e2710b548a8f58ccaffe6e1427c"><td class="memItemLeft" align="right" valign="top"><a id="a09f61e2710b548a8f58ccaffe6e1427c"></a>
<a class="el" href="classenet_1_1_tcp.html">Tcp</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classenet_1_1_tcp.html">Tcp</a> &amp;_obj)=delete</td></tr>
<tr class="separator:a09f61e2710b548a8f58ccaffe6e1427c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad93fb9d484a0eecc2057deee10f445a1"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#ad93fb9d484a0eecc2057deee10f445a1">getName</a> ()</td></tr>
<tr class="separator:ad93fb9d484a0eecc2057deee10f445a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc1608c7f511678b50920688946a7be7"><td class="memItemLeft" align="right" valign="top">enum status&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#adc1608c7f511678b50920688946a7be7">getConnectionStatus</a> () const</td></tr>
<tr class="separator:adc1608c7f511678b50920688946a7be7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44977d6b011acf1c16a794f7ee41ea8c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#a44977d6b011acf1c16a794f7ee41ea8c">unlink</a> ()</td></tr>
<tr class="separator:a44977d6b011acf1c16a794f7ee41ea8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39248e8a9d91624b3e7ffa15db7dc3d3"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#a39248e8a9d91624b3e7ffa15db7dc3d3">read</a> (void *_data, int32_t _maxLen)</td></tr>
<tr class="separator:a39248e8a9d91624b3e7ffa15db7dc3d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fd69af7f485b679a9d53644070e78ac"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#a4fd69af7f485b679a9d53644070e78ac">write</a> (const void *_data, int32_t _len)</td></tr>
<tr class="separator:a4fd69af7f485b679a9d53644070e78ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d6613d3adff8ffa30fdcd6d7ab4faf9"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#a4d6613d3adff8ffa30fdcd6d7ab4faf9">write</a> (const std::string &amp;_data, bool _writeBackSlashZero=true)</td></tr>
<tr class="separator:a4d6613d3adff8ffa30fdcd6d7ab4faf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a630f1853885c26ec868b4b8ac7d91372"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a630f1853885c26ec868b4b8ac7d91372"><td class="memTemplItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classenet_1_1_tcp.html#a630f1853885c26ec868b4b8ac7d91372">write</a> (const std::vector&lt; T &gt; &amp;_data)</td></tr>
<tr class="separator:a630f1853885c26ec868b4b8ac7d91372"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a327e9b0170e9ae7f7e1dc508d76c698d"><td class="memItemLeft" align="right" valign="top"><a id="a327e9b0170e9ae7f7e1dc508d76c698d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>setTCPNoDelay</b> (bool _enabled)</td></tr>
<tr class="separator:a327e9b0170e9ae7f7e1dc508d76c698d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adc1608c7f511678b50920688946a7be7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc1608c7f511678b50920688946a7be7">&sect;&nbsp;</a></span>getConnectionStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum status enet::Tcp::getConnectionStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current Status of the connection. </p>
<dl class="section return"><dt>Returns</dt><dd>The status. </dd></dl>
</div>
</div>
<a id="ad93fb9d484a0eecc2057deee10f445a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad93fb9d484a0eecc2057deee10f445a1">&sect;&nbsp;</a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::string&amp; enet::Tcp::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the decriptive name hot the host:port. </p>
<dl class="section return"><dt>Returns</dt><dd>the string requested </dd></dl>
</div>
</div>
<a id="a39248e8a9d91624b3e7ffa15db7dc3d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39248e8a9d91624b3e7ffa15db7dc3d3">&sect;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t enet::Tcp::read </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>_maxLen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a chunk of data on the socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>pointer on the data might be write </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_maxLen</td><td>Size that can be written on the pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;0 byte size on the socket read </dd>
<dd>
-1 an error occured. </dd></dl>
</div>
</div>
<a id="a44977d6b011acf1c16a794f7ee41ea8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44977d6b011acf1c16a794f7ee41ea8c">&sect;&nbsp;</a></span>unlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool enet::Tcp::unlink </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlink on a specific interface. </p>
<dl class="section return"><dt>Returns</dt><dd>true if connection is removed </dd>
<dd>
false otherwise ... </dd></dl>
</div>
</div>
<a id="a4fd69af7f485b679a9d53644070e78ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fd69af7f485b679a9d53644070e78ac">&sect;&nbsp;</a></span>write() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t enet::Tcp::write </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>_len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a chunk of data on the socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>pointer on the data might be write </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_len</td><td>Size that must be written socket </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;0 byte size on the socket write </dd>
<dd>
-1 an error occured. </dd></dl>
</div>
</div>
<a id="a4d6613d3adff8ffa30fdcd6d7ab4faf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d6613d3adff8ffa30fdcd6d7ab4faf9">&sect;&nbsp;</a></span>write() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t enet::Tcp::write </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>_writeBackSlashZero</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a chunk of data on the socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>String to rite on the soccket </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_writeBackSlashZero</td><td>if false, the \0 is not write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;0 byte size on the socket write </dd>
<dd>
-1 an error occured. </dd></dl>
</div>
</div>
<a id="a630f1853885c26ec868b4b8ac7d91372"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a630f1853885c26ec868b4b8ac7d91372">&sect;&nbsp;</a></span>write() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t enet::Tcp::write </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>_data</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a chunk of data on the socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>String to rite on the soccket </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">_writeBackSlashZero</td><td>if false, the \0 is not write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>&gt;0 T element write on the socket </dd>
<dd>
-1 an error occured. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>framework/atria-soft/enet/enet/<a class="el" href="_tcp_8hpp_source.html">Tcp.hpp</a></li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink