source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_connected_socket.html@ 15

Last change on this file since 15 was 15, checked in by Sanahuja Guillaume, 8 years ago

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