source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_udt_socket.html @ 47

Last change on this file since 47 was 47, checked in by Sanahuja Guillaume, 4 years ago

m
File size: 36.6 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.9.1"/>
7<title>Flair: flair::core::UdtSocket Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtreedata.js"></script>
14<script type="text/javascript" src="navtree.js"></script>
15<script type="text/javascript">
16  $(document).ready(initResizable);
17  $(window).load(resizeHeight);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23  $(document).ready(function() { init_search(); });
24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26</head>
27<body>
28<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29<div id="titlearea">
30<table cellspacing="0" cellpadding="0">
31 <tbody>
32 <tr style="height: 56px;">
33  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
34  <td style="padding-left: 0.5em;">
35   <div id="projectname">Flair
36   </div>
37   <div id="projectbrief">Framework Libre Air</div>
38  </td>
39 </tr>
40 </tbody>
41</table>
42</div>
43<!-- end header part -->
44<!-- Generated by Doxygen 1.8.9.1 -->
45<script type="text/javascript">
46var searchBox = new SearchBox("searchBox", "search",false,'Search');
47</script>
48  <div id="navrow1" class="tabs">
49    <ul class="tablist">
50      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
51      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53      <li><a href="files.html"><span>Files</span></a></li>
54      <li>
55        <div id="MSearchBox" class="MSearchBoxInactive">
56        <span class="left">
57          <img id="MSearchSelect" src="search/mag_sel.png"
58               onmouseover="return searchBox.OnSearchSelectShow()"
59               onmouseout="return searchBox.OnSearchSelectHide()"
60               alt=""/>
61          <input type="text" id="MSearchField" value="Search" accesskey="S"
62               onfocus="searchBox.OnSearchFieldFocus(true)" 
63               onblur="searchBox.OnSearchFieldFocus(false)" 
64               onkeyup="searchBox.OnSearchFieldChange(event)"/>
65          </span><span class="right">
66            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
67          </span>
68        </div>
69      </li>
70    </ul>
71  </div>
72  <div id="navrow2" class="tabs2">
73    <ul class="tablist">
74      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
75      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
76      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
77      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
78    </ul>
79  </div>
80</div><!-- top -->
81<div id="side-nav" class="ui-resizable side-nav-resizable">
82  <div id="nav-tree">
83    <div id="nav-tree-contents">
84      <div id="nav-sync" class="sync"></div>
85    </div>
86  </div>
87  <div id="splitbar" style="-moz-user-select:none;" 
88       class="ui-resizable-handle">
89  </div>
90</div>
91<script type="text/javascript">
92$(document).ready(function(){initNavTree('classflair_1_1core_1_1_udt_socket.html','');});
93</script>
94<div id="doc-content">
95<!-- window showing the filter options -->
96<div id="MSearchSelectWindow"
97     onmouseover="return searchBox.OnSearchSelectShow()"
98     onmouseout="return searchBox.OnSearchSelectHide()"
99     onkeydown="return searchBox.OnSearchSelectKey(event)">
100</div>
101
102<!-- iframe showing the search results (closed by default) -->
103<div id="MSearchResultsWindow">
104<iframe src="javascript:void(0)" frameborder="0" 
105        name="MSearchResults" id="MSearchResults">
106</iframe>
107</div>
108
109<div class="header">
110  <div class="summary">
111<a href="#pub-methods">Public Member Functions</a> &#124;
112<a href="classflair_1_1core_1_1_udt_socket-members.html">List of all members</a>  </div>
113  <div class="headertitle">
114<div class="title">flair::core::UdtSocket Class Reference</div>  </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Class encapsulating a UDT socket. 
119 <a href="classflair_1_1core_1_1_udt_socket.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_udt_socket_8h_source.html">UdtSocket.h</a>&gt;</code></p>
122<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
123  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::core::UdtSocket:</div>
124<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
125</div>
126<div id="dynsection-0-content" class="dyncontent" style="display:none;">
127 <div class="center">
128  <img src="classflair_1_1core_1_1_udt_socket.png" usemap="#flair::core::UdtSocket_map" alt=""/>
129  <map id="flair::core::UdtSocket_map" name="flair::core::UdtSocket_map">
130<area href="classflair_1_1core_1_1_connected_socket.html" title="Interface class encapsulating a connected socket. Preserves packets order and guaranty delivery..." alt="flair::core::ConnectedSocket" shape="rect" coords="0,56,171,80"/>
131<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="0,0,171,24"/>
132</map>
133 </div></div>
134<table class="memberdecls">
135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136Public Member Functions</h2></td></tr>
137<tr class="memitem:a553ef29eadb4545925d5f60ed19cd2d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a553ef29eadb4545925d5f60ed19cd2d4"></a>
138&#160;</td><td class="memItemRight" valign="bottom"><b>UdtSocket</b> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, const std::string name, bool blockOnSend=false, bool blockOnReceive=true)</td></tr>
139<tr class="separator:a553ef29eadb4545925d5f60ed19cd2d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
140<tr class="memitem:a11808b6bc370de061d19bd10dddc662e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_udt_socket.html#a11808b6bc370de061d19bd10dddc662e">Listen</a> (const unsigned int port, const std::string localAddress=&quot;ANY&quot;)</td></tr>
141<tr class="memdesc:a11808b6bc370de061d19bd10dddc662e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a socket which listens on a specific port/address.  <a href="#a11808b6bc370de061d19bd10dddc662e">More...</a><br /></td></tr>
142<tr class="separator:a11808b6bc370de061d19bd10dddc662e"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<tr class="memitem:a358a8188b065b8a7fe82c1a8e594e9fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1_udt_socket.html">UdtSocket</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_udt_socket.html#a358a8188b065b8a7fe82c1a8e594e9fb">Accept</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout)</td></tr>
144<tr class="memdesc:a358a8188b065b8a7fe82c1a8e594e9fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a socket on a new incoming connexion.  <a href="#a358a8188b065b8a7fe82c1a8e594e9fb">More...</a><br /></td></tr>
145<tr class="separator:a358a8188b065b8a7fe82c1a8e594e9fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:a52ce6ff9c4c87c626338987b0b4f2fd1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_udt_socket.html#a52ce6ff9c4c87c626338987b0b4f2fd1">Connect</a> (const unsigned int port, const std::string distantAddress, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout)</td></tr>
147<tr class="memdesc:a52ce6ff9c4c87c626338987b0b4f2fd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a socket connected to a distant host.  <a href="#a52ce6ff9c4c87c626338987b0b4f2fd1">More...</a><br /></td></tr>
148<tr class="separator:a52ce6ff9c4c87c626338987b0b4f2fd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:a9a0424a81914bdb9edaf20783992f7b4"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_udt_socket.html#a9a0424a81914bdb9edaf20783992f7b4">SendMessage</a> (const char *message, size_t message_len, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout)</td></tr>
150<tr class="memdesc:a9a0424a81914bdb9edaf20783992f7b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message.  <a href="#a9a0424a81914bdb9edaf20783992f7b4">More...</a><br /></td></tr>
151<tr class="separator:a9a0424a81914bdb9edaf20783992f7b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:a8f7970d0532c9b280b180a63a6c604bc"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_udt_socket.html#a8f7970d0532c9b280b180a63a6c604bc">RecvMessage</a> (char *buf, size_t buf_len, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout)</td></tr>
153<tr class="memdesc:a8f7970d0532c9b280b180a63a6c604bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a message.  <a href="#a8f7970d0532c9b280b180a63a6c604bc">More...</a><br /></td></tr>
154<tr class="separator:a8f7970d0532c9b280b180a63a6c604bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<tr class="memitem:ac19f18b6ccc17685007fe001e5b710ea"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_udt_socket.html#ac19f18b6ccc17685007fe001e5b710ea">NetworkToHost16</a> (uint16_t data)</td></tr>
156<tr class="memdesc:ac19f18b6ccc17685007fe001e5b710ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">! See <a class="el" href="_socket_8h.html" title="Class defining a UDP socket. ">Socket.h</a> for a more generic implementation of network/host endianness  <a href="#ac19f18b6ccc17685007fe001e5b710ea">More...</a><br /></td></tr>
157<tr class="separator:ac19f18b6ccc17685007fe001e5b710ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:acf2d8bb601058c630a1535d62baa13f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf2d8bb601058c630a1535d62baa13f2"></a>
159uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>HostToNetwork16</b> (uint16_t data)</td></tr>
160<tr class="separator:acf2d8bb601058c630a1535d62baa13f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:adb2fc5811369b4178f569ac7f303c93a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb2fc5811369b4178f569ac7f303c93a"></a>
162uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>NetworkToHost32</b> (uint32_t data)</td></tr>
163<tr class="separator:adb2fc5811369b4178f569ac7f303c93a"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:a9b99b74d9121098c41942dcfa5822ced"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b99b74d9121098c41942dcfa5822ced"></a>
165uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>HostToNetwork32</b> (uint32_t data)</td></tr>
166<tr class="separator:a9b99b74d9121098c41942dcfa5822ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="inherit_header pub_methods_classflair_1_1core_1_1_connected_socket"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_connected_socket')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_connected_socket.html">flair::core::ConnectedSocket</a></td></tr>
168<tr class="memitem:a61c0bbd4147f994cc2f0276cc6982447 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_connected_socket.html#a61c0bbd4147f994cc2f0276cc6982447">ConnectedSocket</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, const std::string name)</td></tr>
169<tr class="memdesc:a61c0bbd4147f994cc2f0276cc6982447 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a61c0bbd4147f994cc2f0276cc6982447">More...</a><br /></td></tr>
170<tr class="separator:a61c0bbd4147f994cc2f0276cc6982447 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<tr class="memitem:ad4e96a4fead5a5a1c038a31fa7dfd36b inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_connected_socket.html#ad4e96a4fead5a5a1c038a31fa7dfd36b">~ConnectedSocket</a> ()</td></tr>
172<tr class="memdesc:ad4e96a4fead5a5a1c038a31fa7dfd36b inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ad4e96a4fead5a5a1c038a31fa7dfd36b">More...</a><br /></td></tr>
173<tr class="separator:ad4e96a4fead5a5a1c038a31fa7dfd36b inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
174<tr class="memitem:a0b9c506b8cb481d90e00c487bf48a169 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b9c506b8cb481d90e00c487bf48a169"></a>
175std::string&#160;</td><td class="memItemRight" valign="bottom"><b>ReadString</b> (const size_t &amp;stringLength, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout)</td></tr>
176<tr class="separator:a0b9c506b8cb481d90e00c487bf48a169 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
177<tr class="memitem:ac3de6fad3ddd34fb7f9928e04abdc746 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3de6fad3ddd34fb7f9928e04abdc746"></a>
178uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>ReadUInt16</b> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> const &amp;timeout)</td></tr>
179<tr class="separator:ac3de6fad3ddd34fb7f9928e04abdc746 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
180<tr class="memitem:aad9de20aee680674861f6ee216a12c82 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad9de20aee680674861f6ee216a12c82"></a>
181void&#160;</td><td class="memItemRight" valign="bottom"><b>WriteUInt16</b> (uint16_t const &amp;data, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> const &amp;timeout)</td></tr>
182<tr class="separator:aad9de20aee680674861f6ee216a12c82 inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
183<tr class="memitem:ae718da5dcb14ba66ef03c645c922b9cb inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae718da5dcb14ba66ef03c645c922b9cb"></a>
184uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>ReadUInt32</b> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> const &amp;timeout)</td></tr>
185<tr class="separator:ae718da5dcb14ba66ef03c645c922b9cb inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
186<tr class="memitem:a74f5b08f78dd97aea132bcdfe2cb191c inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74f5b08f78dd97aea132bcdfe2cb191c"></a>
187void&#160;</td><td class="memItemRight" valign="bottom"><b>WriteUInt32</b> (uint32_t const &amp;data, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> const &amp;timeout)</td></tr>
188<tr class="separator:a74f5b08f78dd97aea132bcdfe2cb191c inherit pub_methods_classflair_1_1core_1_1_connected_socket"><td class="memSeparator" colspan="2">&#160;</td></tr>
189<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
190<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
191<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
192<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
193<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
194<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
195<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
196<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
197<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
198<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
199<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
200<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
201<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
202<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
203<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
204<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
205<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
206<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
207<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
208<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
209<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
210<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
211<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
212<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
213<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
214<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
215<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
216<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
217<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
218<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
219<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
220<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
221<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
222<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
223</table><table class="memberdecls">
224<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
225Additional Inherited Members</h2></td></tr>
226<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
227<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
228<b>Red</b> = 31,
229<b>Green</b> = 32,
230<b>Orange</b> = 33
231 }</td></tr>
232<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
233</table>
234<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
235<div class="textblock"><p>Class encapsulating a UDT socket. </p>
236</div><h2 class="groupheader">Member Function Documentation</h2>
237<a class="anchor" id="a11808b6bc370de061d19bd10dddc662e"></a>
238<div class="memitem">
239<div class="memproto">
240<table class="mlabels">
241  <tr>
242  <td class="mlabels-left">
243      <table class="memname">
244        <tr>
245          <td class="memname">void flair::core::UdtSocket::Listen </td>
246          <td>(</td>
247          <td class="paramtype">const unsigned int&#160;</td>
248          <td class="paramname"><em>port</em>, </td>
249        </tr>
250        <tr>
251          <td class="paramkey"></td>
252          <td></td>
253          <td class="paramtype">const std::string&#160;</td>
254          <td class="paramname"><em>localAddress</em> = <code>&quot;ANY&quot;</code>&#160;</td>
255        </tr>
256        <tr>
257          <td></td>
258          <td>)</td>
259          <td></td><td></td>
260        </tr>
261      </table>
262  </td>
263  <td class="mlabels-right">
264<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
265  </tr>
266</table>
267</div><div class="memdoc">
268
269<p>Returns a socket which listens on a specific port/address. </p>
270<dl class="params"><dt>Parameters</dt><dd>
271  <table class="params">
272    <tr><td class="paramname">const</td><td>Object* parentObject </td></tr>
273    <tr><td class="paramname">const</td><td>string name </td></tr>
274    <tr><td class="paramname">unsigned</td><td>int port </td></tr>
275    <tr><td class="paramname">const</td><td>localAddress (defaults to any) </td></tr>
276  </table>
277  </dd>
278</dl>
279
280<p>Implements <a class="el" href="classflair_1_1core_1_1_connected_socket.html#ab522b80d805132cd0762f44852085613">flair::core::ConnectedSocket</a>.</p>
281
282</div>
283</div>
284<a class="anchor" id="a358a8188b065b8a7fe82c1a8e594e9fb"></a>
285<div class="memitem">
286<div class="memproto">
287<table class="mlabels">
288  <tr>
289  <td class="mlabels-left">
290      <table class="memname">
291        <tr>
292          <td class="memname"><a class="el" href="classflair_1_1core_1_1_udt_socket.html">UdtSocket</a>* flair::core::UdtSocket::Accept </td>
293          <td>(</td>
294          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
295          <td class="paramname"><em>timeout</em></td><td>)</td>
296          <td></td>
297        </tr>
298      </table>
299  </td>
300  <td class="mlabels-right">
301<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
302  </tr>
303</table>
304</div><div class="memdoc">
305
306<p>Returns a socket on a new incoming connexion. </p>
307<dl class="params"><dt>Parameters</dt><dd>
308  <table class="params">
309    <tr><td class="paramname"><a class="el" href="classflair_1_1core_1_1_connected_socket.html" title="Interface class encapsulating a connected socket. Preserves packets order and guaranty delivery...">ConnectedSocket</a></td><td>&amp;listeningSocket </td></tr>
310  </table>
311  </dd>
312</dl>
313
314<p>Implements <a class="el" href="classflair_1_1core_1_1_connected_socket.html#a8c89979efaba9298d32c58a07021f2e0">flair::core::ConnectedSocket</a>.</p>
315
316</div>
317</div>
318<a class="anchor" id="a52ce6ff9c4c87c626338987b0b4f2fd1"></a>
319<div class="memitem">
320<div class="memproto">
321<table class="mlabels">
322  <tr>
323  <td class="mlabels-left">
324      <table class="memname">
325        <tr>
326          <td class="memname">bool flair::core::UdtSocket::Connect </td>
327          <td>(</td>
328          <td class="paramtype">const unsigned int&#160;</td>
329          <td class="paramname"><em>port</em>, </td>
330        </tr>
331        <tr>
332          <td class="paramkey"></td>
333          <td></td>
334          <td class="paramtype">const std::string&#160;</td>
335          <td class="paramname"><em>distantAddress</em>, </td>
336        </tr>
337        <tr>
338          <td class="paramkey"></td>
339          <td></td>
340          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
341          <td class="paramname"><em>timeout</em>&#160;</td>
342        </tr>
343        <tr>
344          <td></td>
345          <td>)</td>
346          <td></td><td></td>
347        </tr>
348      </table>
349  </td>
350  <td class="mlabels-right">
351<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
352  </tr>
353</table>
354</div><div class="memdoc">
355
356<p>Returns a socket connected to a distant host. </p>
357<dl class="params"><dt>Parameters</dt><dd>
358  <table class="params">
359    <tr><td class="paramname">const</td><td>Object* parentObject </td></tr>
360    <tr><td class="paramname">const</td><td>string name </td></tr>
361    <tr><td class="paramname">unsigned</td><td>int port </td></tr>
362    <tr><td class="paramname">const</td><td>distantAddress </td></tr>
363    <tr><td class="paramname">timeout</td><td>timeout (in milliseconds) </td></tr>
364  </table>
365  </dd>
366</dl>
367
368<p>Implements <a class="el" href="classflair_1_1core_1_1_connected_socket.html#aebfdaebe07aee9b77b75d56e61fd6926">flair::core::ConnectedSocket</a>.</p>
369
370</div>
371</div>
372<a class="anchor" id="a9a0424a81914bdb9edaf20783992f7b4"></a>
373<div class="memitem">
374<div class="memproto">
375<table class="mlabels">
376  <tr>
377  <td class="mlabels-left">
378      <table class="memname">
379        <tr>
380          <td class="memname">ssize_t flair::core::UdtSocket::SendMessage </td>
381          <td>(</td>
382          <td class="paramtype">const char *&#160;</td>
383          <td class="paramname"><em>message</em>, </td>
384        </tr>
385        <tr>
386          <td class="paramkey"></td>
387          <td></td>
388          <td class="paramtype">size_t&#160;</td>
389          <td class="paramname"><em>message_len</em>, </td>
390        </tr>
391        <tr>
392          <td class="paramkey"></td>
393          <td></td>
394          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
395          <td class="paramname"><em>timeout</em>&#160;</td>
396        </tr>
397        <tr>
398          <td></td>
399          <td>)</td>
400          <td></td><td></td>
401        </tr>
402      </table>
403  </td>
404  <td class="mlabels-right">
405<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
406  </tr>
407</table>
408</div><div class="memdoc">
409
410<p>Send a message. </p>
411<dl class="params"><dt>Parameters</dt><dd>
412  <table class="params">
413    <tr><td class="paramname">message</td><td>message </td></tr>
414    <tr><td class="paramname">message_len</td><td>message length </td></tr>
415    <tr><td class="paramname">timeout</td><td>timeout (in milliseconds) </td></tr>
416  </table>
417  </dd>
418</dl>
419
420<p>Implements <a class="el" href="classflair_1_1core_1_1_connected_socket.html#aed7d5a9e49996bf672050f95f82d85b4">flair::core::ConnectedSocket</a>.</p>
421
422</div>
423</div>
424<a class="anchor" id="a8f7970d0532c9b280b180a63a6c604bc"></a>
425<div class="memitem">
426<div class="memproto">
427<table class="mlabels">
428  <tr>
429  <td class="mlabels-left">
430      <table class="memname">
431        <tr>
432          <td class="memname">ssize_t flair::core::UdtSocket::RecvMessage </td>
433          <td>(</td>
434          <td class="paramtype">char *&#160;</td>
435          <td class="paramname"><em>buf</em>, </td>
436        </tr>
437        <tr>
438          <td class="paramkey"></td>
439          <td></td>
440          <td class="paramtype">size_t&#160;</td>
441          <td class="paramname"><em>buf_len</em>, </td>
442        </tr>
443        <tr>
444          <td class="paramkey"></td>
445          <td></td>
446          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
447          <td class="paramname"><em>timeout</em>&#160;</td>
448        </tr>
449        <tr>
450          <td></td>
451          <td>)</td>
452          <td></td><td></td>
453        </tr>
454      </table>
455  </td>
456  <td class="mlabels-right">
457<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
458  </tr>
459</table>
460</div><div class="memdoc">
461
462<p>Receive a message. </p>
463<p>Receive a message and wait up to timeout. <br />
464 </p><dl class="params"><dt>Parameters</dt><dd>
465  <table class="params">
466    <tr><td class="paramname">buf</td><td>buffer to put the message </td></tr>
467    <tr><td class="paramname">buf_len</td><td>buffer length </td></tr>
468    <tr><td class="paramname">timeout</td><td>timeout (in milliseconds)</td></tr>
469  </table>
470  </dd>
471</dl>
472<dl class="section return"><dt>Returns</dt><dd>size of the received message </dd></dl>
473
474<p>Implements <a class="el" href="classflair_1_1core_1_1_connected_socket.html#ade302ba4b2afddd6b421823a261f01c9">flair::core::ConnectedSocket</a>.</p>
475
476</div>
477</div>
478<a class="anchor" id="ac19f18b6ccc17685007fe001e5b710ea"></a>
479<div class="memitem">
480<div class="memproto">
481<table class="mlabels">
482  <tr>
483  <td class="mlabels-left">
484      <table class="memname">
485        <tr>
486          <td class="memname">uint16_t flair::core::UdtSocket::NetworkToHost16 </td>
487          <td>(</td>
488          <td class="paramtype">uint16_t&#160;</td>
489          <td class="paramname"><em>data</em></td><td>)</td>
490          <td></td>
491        </tr>
492      </table>
493  </td>
494  <td class="mlabels-right">
495<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
496  </tr>
497</table>
498</div><div class="memdoc">
499
500<p>! See <a class="el" href="_socket_8h.html" title="Class defining a UDP socket. ">Socket.h</a> for a more generic implementation of network/host endianness </p>
501
502<p>Implements <a class="el" href="classflair_1_1core_1_1_connected_socket.html#a01410482ffeca813adcd5240cc69292d">flair::core::ConnectedSocket</a>.</p>
503
504</div>
505</div>
506</div><!-- contents -->
507</div><!-- doc-content -->
508<!-- start footer part -->
509<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
510  <ul>
511    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_udt_socket.html">UdtSocket</a></li>
512    <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
513    <a href="http://www.doxygen.org/index.html">
514    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
515  </ul>
516</div>
517</body>
518</html>
Note: See TracBrowser for help on using the repository browser.