[14] | 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"/> |
---|
[23] | 6 | <meta name="generator" content="Doxygen 1.8.9.1"/> |
---|
[14] | 7 | <title>Flair: SharedMem.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> |
---|
[23] | 13 | <script type="text/javascript" src="navtreedata.js"></script> |
---|
[14] | 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"/> |
---|
[23] | 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
---|
[14] | 21 | <script type="text/javascript" src="search/search.js"></script> |
---|
| 22 | <script type="text/javascript"> |
---|
[23] | 23 | $(document).ready(function() { init_search(); }); |
---|
[14] | 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 --> |
---|
[23] | 44 | <!-- Generated by Doxygen 1.8.9.1 --> |
---|
[14] | 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('_shared_mem_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)"> |
---|
[23] | 97 | </div> |
---|
[14] | 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">SharedMem.h</div> </div> |
---|
| 109 | </div><!--header--> |
---|
| 110 | <div class="contents"> |
---|
| 111 | <a href="_shared_mem_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 SHAREDMEM_H</span></div> |
---|
| 116 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define SHAREDMEM_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> <span class="preprocessor">#include <semaphore.h></span></div> |
---|
| 120 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> |
---|
| 121 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>SharedMem_impl;</div> |
---|
| 122 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> |
---|
[23] | 123 | <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div> |
---|
[14] | 124 | <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>core {</div> |
---|
| 125 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> |
---|
| 126 | <div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_shared_mem.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_shared_mem.html">SharedMem</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div> |
---|
| 127 | <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div> |
---|
[50] | 128 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">enum class</span> Type { mutex, producerConsumer };</div> |
---|
[74] | 129 | <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a003b9e48b88ac57bb7255b80f7768d9f">SharedMem</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name, <span class="keywordtype">size_t</span> size, Type type=Type::mutex);</div> |
---|
| 130 | <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> |
---|
| 131 | <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classflair_1_1core_1_1_shared_mem.html#af3f51c01e679a8dd1f6f7c64cee55ed7">~SharedMem</a>();</div> |
---|
| 132 | <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div> |
---|
| 133 | <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a7609d68ab9155055bea84cafaf741392">Write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> size);</div> |
---|
| 134 | <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> |
---|
| 135 | <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#a834ba5f2d06345b0125f7ba8b66391b6">Read</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> size, <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> nsTimeout=TIME_INFINITE) <span class="keyword">const</span>;</div> |
---|
[50] | 136 | <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> |
---|
[74] | 137 | <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> |
---|
| 138 | <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_shared_mem.html#aead806d7b3e48aecefcbb3dcd724ef49">ReaderReady</a>();</div> |
---|
| 139 | <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">private</span>:</div> |
---|
| 140 | <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  SharedMem_impl *pimpl_;</div> |
---|
| 141 | <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  Type type;</div> |
---|
| 142 | <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div> |
---|
| 143 | <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> |
---|
| 144 | <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> } <span class="comment">// end namespace core</span></div> |
---|
| 145 | <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">// end namespace flair</span></div> |
---|
| 146 | <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> |
---|
| 147 | <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif // SHAREDMEM_H</span></div> |
---|
[14] | 148 | <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> |
---|
[23] | 149 | <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> |
---|
[62] | 150 | <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_aead806d7b3e48aecefcbb3dcd724ef49"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#aead806d7b3e48aecefcbb3dcd724ef49">flair::core::SharedMem::ReaderReady</a></div><div class="ttdeci">void ReaderReady()</div><div class="ttdoc">This function should be called when reader is ready (in case of a SharedMem of type producerConsumer)...</div></div> |
---|
[50] | 151 | <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_a003b9e48b88ac57bb7255b80f7768d9f"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#a003b9e48b88ac57bb7255b80f7768d9f">flair::core::SharedMem::SharedMem</a></div><div class="ttdeci">SharedMem(const Object *parent, std::string name, size_t size, Type type=Type::mutex)</div><div class="ttdoc">Constructor. </div></div> |
---|
[62] | 152 | <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> |
---|
| 153 | <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_a834ba5f2d06345b0125f7ba8b66391b6"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#a834ba5f2d06345b0125f7ba8b66391b6">flair::core::SharedMem::Read</a></div><div class="ttdeci">bool Read(char *buf, size_t size, Time nsTimeout=TIME_INFINITE) const </div><div class="ttdoc">Read. </div></div> |
---|
[14] | 154 | <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html">flair::core::SharedMem</a></div><div class="ttdoc">Class defining a shared memory. </div><div class="ttdef"><b>Definition:</b> SharedMem.h:32</div></div> |
---|
| 155 | <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> |
---|
| 156 | <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_af3f51c01e679a8dd1f6f7c64cee55ed7"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#af3f51c01e679a8dd1f6f7c64cee55ed7">flair::core::SharedMem::~SharedMem</a></div><div class="ttdeci">~SharedMem()</div><div class="ttdoc">Destructor. </div></div> |
---|
| 157 | <div class="ttc" id="classflair_1_1core_1_1_shared_mem_html_a7609d68ab9155055bea84cafaf741392"><div class="ttname"><a href="classflair_1_1core_1_1_shared_mem.html#a7609d68ab9155055bea84cafaf741392">flair::core::SharedMem::Write</a></div><div class="ttdeci">void Write(const char *buf, size_t size)</div><div class="ttdoc">Write. </div></div> |
---|
| 158 | </div><!-- fragment --></div><!-- contents --> |
---|
| 159 | </div><!-- doc-content --> |
---|
| 160 | <!-- start footer part --> |
---|
| 161 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
---|
| 162 | <ul> |
---|
[26] | 163 | <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="_shared_mem_8h.html">SharedMem.h</a></li> |
---|
[89] | 164 | <li class="footer">Generated on Fri Nov 30 2018 16:40:51 for Flair by |
---|
[14] | 165 | <a href="http://www.doxygen.org/index.html"> |
---|
[23] | 166 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> |
---|
[14] | 167 | </ul> |
---|
| 168 | </div> |
---|
| 169 | </body> |
---|
| 170 | </html> |
---|