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: ConnectedSocket.h Source File</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">
|
---|
46 | var 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 Page</span></a></li>
|
---|
51 | <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
---|
52 | <li><a href="annotated.html"><span>Classes</span></a></li>
|
---|
53 | <li class="current"><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="files.html"><span>File List</span></a></li>
|
---|
75 | </ul>
|
---|
76 | </div>
|
---|
77 | </div><!-- top -->
|
---|
78 | <div id="side-nav" class="ui-resizable side-nav-resizable">
|
---|
79 | <div id="nav-tree">
|
---|
80 | <div id="nav-tree-contents">
|
---|
81 | <div id="nav-sync" class="sync"></div>
|
---|
82 | </div>
|
---|
83 | </div>
|
---|
84 | <div id="splitbar" style="-moz-user-select:none;"
|
---|
85 | class="ui-resizable-handle">
|
---|
86 | </div>
|
---|
87 | </div>
|
---|
88 | <script type="text/javascript">
|
---|
89 | $(document).ready(function(){initNavTree('_connected_socket_8h_source.html','');});
|
---|
90 | </script>
|
---|
91 | <div id="doc-content">
|
---|
92 | <!-- window showing the filter options -->
|
---|
93 | <div id="MSearchSelectWindow"
|
---|
94 | onmouseover="return searchBox.OnSearchSelectShow()"
|
---|
95 | onmouseout="return searchBox.OnSearchSelectHide()"
|
---|
96 | onkeydown="return searchBox.OnSearchSelectKey(event)">
|
---|
97 | </div>
|
---|
98 |
|
---|
99 | <!-- iframe showing the search results (closed by default) -->
|
---|
100 | <div id="MSearchResultsWindow">
|
---|
101 | <iframe src="javascript:void(0)" frameborder="0"
|
---|
102 | name="MSearchResults" id="MSearchResults">
|
---|
103 | </iframe>
|
---|
104 | </div>
|
---|
105 |
|
---|
106 | <div class="header">
|
---|
107 | <div class="headertitle">
|
---|
108 | <div class="title">ConnectedSocket.h</div> </div>
|
---|
109 | </div><!--header-->
|
---|
110 | <div class="contents">
|
---|
111 | <a href="_connected_socket_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// %flair:license{</span></div>
|
---|
112 | <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// This file is part of the Flair framework distributed under the</span></div>
|
---|
113 | <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// CECILL-C License, Version 1.0.</span></div>
|
---|
114 | <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// %flair:license}</span></div>
|
---|
115 | <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span><span class="preprocessor">#ifndef CONNECTEDSOCKET_H</span></div>
|
---|
116 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define CONNECTEDSOCKET_H</span></div>
|
---|
117 | <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
---|
118 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="_object_8h.html">Object.h</a>></span></div>
|
---|
119 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
---|
120 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
|
---|
121 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>core {</div>
|
---|
122 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
|
---|
123 | <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_connected_socket.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_connected_socket.html">ConnectedSocket</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div>
|
---|
124 | <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
|
---|
125 | <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classflair_1_1core_1_1_connected_socket.html#a61c0bbd4147f994cc2f0276cc6982447">ConnectedSocket</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, <span class="keyword">const</span> std::string name);</div>
|
---|
126 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
---|
127 | <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classflair_1_1core_1_1_connected_socket.html#ad4e96a4fead5a5a1c038a31fa7dfd36b">~ConnectedSocket</a>();</div>
|
---|
128 | <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
|
---|
129 | <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_connected_socket.html#ab522b80d805132cd0762f44852085613">Listen</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> port,</div>
|
---|
130 | <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> std::string localAddress = <span class="stringliteral">"ANY"</span>) = 0;</div>
|
---|
131 | <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
|
---|
132 | <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_connected_socket.html">ConnectedSocket</a> *<a class="code" href="classflair_1_1core_1_1_connected_socket.html#a8c89979efaba9298d32c58a07021f2e0">Accept</a>(</div>
|
---|
133 | <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout) = 0; <span class="comment">// should throw an exception if not a listening socket</span></div>
|
---|
134 | <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
|
---|
135 | <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1core_1_1_connected_socket.html#aebfdaebe07aee9b77b75d56e61fd6926">Connect</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> port,</div>
|
---|
136 | <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> std::string distantAddress, <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout) = 0;</div>
|
---|
137 | <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
---|
138 | <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> ssize_t <a class="code" href="classflair_1_1core_1_1_connected_socket.html#aed7d5a9e49996bf672050f95f82d85b4">SendMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *message, <span class="keywordtype">size_t</span> message_len,</div>
|
---|
139 | <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout) = 0;</div>
|
---|
140 | <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
|
---|
141 | <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">virtual</span> ssize_t <a class="code" href="classflair_1_1core_1_1_connected_socket.html#ade302ba4b2afddd6b421823a261f01c9">RecvMessage</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> buf_len, <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout) = 0;</div>
|
---|
142 | <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
---|
143 | <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::string ReadString(<span class="keyword">const</span> <span class="keywordtype">size_t</span> &stringLength, <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout);</div>
|
---|
144 | <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  uint16_t ReadUInt16(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> <span class="keyword">const</span> &timeout);</div>
|
---|
145 | <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> WriteUInt16(uint16_t <span class="keyword">const</span> &data, <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> <span class="keyword">const</span> &timeout);</div>
|
---|
146 | <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  uint32_t ReadUInt32(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> <span class="keyword">const</span> &timeout);</div>
|
---|
147 | <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">void</span> WriteUInt32(uint32_t <span class="keyword">const</span> &data, <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> <span class="keyword">const</span> &timeout);</div>
|
---|
148 | <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
|
---|
149 | <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">// conversion</span></div>
|
---|
150 | <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">virtual</span> uint16_t <a class="code" href="classflair_1_1core_1_1_connected_socket.html#a01410482ffeca813adcd5240cc69292d">NetworkToHost16</a>(uint16_t data) = 0;</div>
|
---|
151 | <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> uint16_t HostToNetwork16(uint16_t data) = 0;</div>
|
---|
152 | <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> uint32_t NetworkToHost32(uint32_t data) = 0;</div>
|
---|
153 | <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">virtual</span> uint32_t HostToNetwork32(uint32_t data) = 0;</div>
|
---|
154 | <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> };</div>
|
---|
155 | <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
|
---|
156 | <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> } <span class="comment">// end namespace core</span></div>
|
---|
157 | <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">// end namespace flair</span></div>
|
---|
158 | <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
|
---|
159 | <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#endif // CONNECTEDSOCKET_H</span></div>
|
---|
160 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html">flair::core::ConnectedSocket</a></div><div class="ttdoc">Interface class encapsulating a connected socket. Preserves packets order and guaranty delivery...</div><div class="ttdef"><b>Definition:</b> ConnectedSocket.h:27</div></div>
|
---|
161 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_ab522b80d805132cd0762f44852085613"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#ab522b80d805132cd0762f44852085613">flair::core::ConnectedSocket::Listen</a></div><div class="ttdeci">virtual void Listen(const unsigned int port, const std::string localAddress="ANY")=0</div><div class="ttdoc">Returns a socket which listens on a specific port/address. </div></div>
|
---|
162 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_aed7d5a9e49996bf672050f95f82d85b4"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#aed7d5a9e49996bf672050f95f82d85b4">flair::core::ConnectedSocket::SendMessage</a></div><div class="ttdeci">virtual ssize_t SendMessage(const char *message, size_t message_len, Time timeout)=0</div><div class="ttdoc">Send a message waiting up to timeout ns. </div></div>
|
---|
163 | <div class="ttc" id="classflair_1_1core_1_1_object_html"><div class="ttname"><a href="classflair_1_1core_1_1_object.html">flair::core::Object</a></div><div class="ttdoc">Base class for all Framework's classes. </div><div class="ttdef"><b>Definition:</b> Object.h:77</div></div>
|
---|
164 | <div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div>
|
---|
165 | <div class="ttc" id="namespaceflair_1_1core_html_acc0fa041e08ecf73b2d1d723c339a736"><div class="ttname"><a href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">flair::core::Time</a></div><div class="ttdeci">unsigned long long Time</div><div class="ttdoc">Time definition, in ns. </div><div class="ttdef"><b>Definition:</b> Object.h:49</div></div>
|
---|
166 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_ad4e96a4fead5a5a1c038a31fa7dfd36b"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#ad4e96a4fead5a5a1c038a31fa7dfd36b">flair::core::ConnectedSocket::~ConnectedSocket</a></div><div class="ttdeci">~ConnectedSocket()</div><div class="ttdoc">Destructor. </div></div>
|
---|
167 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_a61c0bbd4147f994cc2f0276cc6982447"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#a61c0bbd4147f994cc2f0276cc6982447">flair::core::ConnectedSocket::ConnectedSocket</a></div><div class="ttdeci">ConnectedSocket(const Object *parent, const std::string name)</div><div class="ttdoc">Constructor. </div></div>
|
---|
168 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_aebfdaebe07aee9b77b75d56e61fd6926"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#aebfdaebe07aee9b77b75d56e61fd6926">flair::core::ConnectedSocket::Connect</a></div><div class="ttdeci">virtual bool Connect(const unsigned int port, const std::string distantAddress, Time timeout)=0</div><div class="ttdoc">Returns a socket connected to a distant host. </div></div>
|
---|
169 | <div class="ttc" id="_object_8h_html"><div class="ttname"><a href="_object_8h.html">Object.h</a></div><div class="ttdoc">Base class for all Framework's classes. </div></div>
|
---|
170 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_ade302ba4b2afddd6b421823a261f01c9"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#ade302ba4b2afddd6b421823a261f01c9">flair::core::ConnectedSocket::RecvMessage</a></div><div class="ttdeci">virtual ssize_t RecvMessage(char *buf, size_t buf_len, Time timeout)=0</div><div class="ttdoc">Receive a message. </div></div>
|
---|
171 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_a01410482ffeca813adcd5240cc69292d"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#a01410482ffeca813adcd5240cc69292d">flair::core::ConnectedSocket::NetworkToHost16</a></div><div class="ttdeci">virtual uint16_t NetworkToHost16(uint16_t data)=0</div><div class="ttdoc">! See Socket.h for a more generic implementation of network/host endianness </div></div>
|
---|
172 | <div class="ttc" id="classflair_1_1core_1_1_connected_socket_html_a8c89979efaba9298d32c58a07021f2e0"><div class="ttname"><a href="classflair_1_1core_1_1_connected_socket.html#a8c89979efaba9298d32c58a07021f2e0">flair::core::ConnectedSocket::Accept</a></div><div class="ttdeci">virtual ConnectedSocket * Accept(Time timeout)=0</div><div class="ttdoc">Returns a socket on a new incoming connexion. </div></div>
|
---|
173 | </div><!-- fragment --></div><!-- contents -->
|
---|
174 | </div><!-- doc-content -->
|
---|
175 | <!-- start footer part -->
|
---|
176 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
---|
177 | <ul>
|
---|
178 | <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_97265977dbbd48c696782ccac102bad5.html">FlairCore</a></li><li class="navelem"><a class="el" href="dir_6c198461db290ac9abcdd44184573216.html">src</a></li><li class="navelem"><a class="el" href="_connected_socket_8h.html">ConnectedSocket.h</a></li>
|
---|
179 | <li class="footer">Generated on Fri Nov 30 2018 16:40:51 for Flair by
|
---|
180 | <a href="http://www.doxygen.org/index.html">
|
---|
181 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
---|
182 | </ul>
|
---|
183 | </div>
|
---|
184 | </body>
|
---|
185 | </html>
|
---|