|
3 | 3 | <head> |
4 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
5 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
6 | | -<meta name="generator" content="Doxygen 1.12.0"/> |
| 6 | +<meta name="generator" content="Doxygen 1.13.2"/> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
8 | 8 | <!-- BEGIN opengraph metadata --> |
9 | 9 | <meta property="og:title" content="QuarkTS++ OS" /> |
|
78 | 78 | </table> |
79 | 79 | </div> |
80 | 80 | <!-- end header part --> |
81 | | -<!-- Generated by Doxygen 1.12.0 --> |
| 81 | +<!-- Generated by Doxygen 1.13.2 --> |
82 | 82 | <script type="text/javascript"> |
83 | 83 | /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
84 | 84 | var searchBox = new SearchBox("searchBox", "search/",'.html'); |
|
150 | 150 | <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div> |
151 | 151 | <div class="foldopen" id="foldopen00007" data-start="{" data-end="}"> |
152 | 152 | <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"><a class="line" href="namespaceq_o_s.html"> 7</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceq_o_s.html">qOS</a> {</div> |
153 | | -<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div> |
| 153 | +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span></div> |
| 154 | +<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span></div> |
154 | 155 | <div class="foldopen" id="foldopen00017" data-start="{" data-end="};"> |
155 | | -<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html"> 17</a></span> <span class="keyword">class </span><a class="code hl_class" href="classq_o_s_1_1byte_buffer.html">byteBuffer</a> {</div> |
| 156 | +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html"> 17</a></span> <span class="keyword">class </span>byteBuffer {</div> |
156 | 157 | <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">private</span>:</div> |
157 | 158 | <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__qtypes.html#ga958a9c1f540e61e60e7893fccccf1d51">byte_t</a> *buffer{ <span class="keyword">nullptr</span> };</div> |
158 | 159 | <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__qtypes.html#ga48c5a581072593753ba3ce0d00c38620">index_t</a> tail{ 0U };</div> |
159 | 160 | <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__qtypes.html#ga48c5a581072593753ba3ce0d00c38620">index_t</a> head{ 0U };</div> |
160 | 161 | <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">size_t</span> length{ 0U };</div> |
161 | 162 | <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">static</span> <span class="keywordtype">size_t</span> checkValidPowerOfTwo( <span class="keywordtype">size_t</span> k ) <span class="keyword">noexcept</span>;</div> |
162 | | -<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_class" href="classq_o_s_1_1byte_buffer.html">byteBuffer</a>( <a class="code hl_class" href="classq_o_s_1_1byte_buffer.html">byteBuffer</a> <span class="keyword">const</span>& ) = <span class="keyword">delete</span>;</div> |
163 | | -<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">void</span> operator=( <a class="code hl_class" href="classq_o_s_1_1byte_buffer.html">byteBuffer</a> <span class="keyword">const</span>& ) = <span class="keyword">delete</span>;</div> |
| 163 | +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> byteBuffer( byteBuffer <span class="keyword">const</span>& ) = <span class="keyword">delete</span>;</div> |
| 164 | +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordtype">void</span> operator=( byteBuffer <span class="keyword">const</span>& ) = <span class="keyword">delete</span>;</div> |
164 | 165 | <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div> |
165 | | -<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classq_o_s_1_1byte_buffer.html">~byteBuffer</a>() {}</div> |
| 166 | +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">virtual</span> ~byteBuffer() {}</div> |
166 | 167 | <div class="foldopen" id="foldopen00035" data-start="{" data-end="}"> |
167 | 168 | <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html#ab27c611dac4ad313f16d55020cfec21a"> 35</a></span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#ab27c611dac4ad313f16d55020cfec21a">byteBuffer</a>( <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__qtypes.html#ga958a9c1f540e61e60e7893fccccf1d51">byte_t</a> *pBuffer, <span class="keyword">const</span> <span class="keywordtype">size_t</span> bLength )</div> |
168 | 169 | <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div> |
|
176 | 177 | <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> (void)<a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#a5dc6270012d89e5ba37052df073d7ee9">setup</a>( area, numberOfBytes );</div> |
177 | 178 | <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div> |
178 | 179 | </div> |
| 180 | +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span></div> |
179 | 181 | <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html#a5dc6270012d89e5ba37052df073d7ee9"> 50</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#a5dc6270012d89e5ba37052df073d7ee9">setup</a>( <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__qtypes.html#ga958a9c1f540e61e60e7893fccccf1d51">byte_t</a> *pBuffer, <span class="keyword">const</span> <span class="keywordtype">size_t</span> bLength ) <span class="keyword">noexcept</span>;</div> |
180 | 182 | <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">template</span> <<span class="keywordtype">size_t</span> numberOfBytes></div> |
181 | 183 | <div class="foldopen" id="foldopen00052" data-start="{" data-end="}"> |
|
184 | 186 | <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">return</span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#a5dc6270012d89e5ba37052df073d7ee9">setup</a>( area, numberOfBytes );</div> |
185 | 187 | <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div> |
186 | 188 | </div> |
| 189 | +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span></div> |
187 | 190 | <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html#aa0f78551140dee000951cff92eab831f"> 61</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#aa0f78551140dee000951cff92eab831f">put</a>( <span class="keyword">const</span> <a class="code hl_typedef" href="group__qtypes.html#ga958a9c1f540e61e60e7893fccccf1d51">byte_t</a> bData ) <span class="keyword">noexcept</span>;</div> |
188 | 191 | <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html#a5606af1fab73ee13728d33d306cc1d41"> 68</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#a5606af1fab73ee13728d33d306cc1d41">read</a>( <span class="keywordtype">void</span> *dst, <span class="keyword">const</span> <span class="keywordtype">size_t</span> n ) <span class="keyword">noexcept</span>;</div> |
189 | 192 | <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html#a6950adb7dd9a398ddca523c9542a5ad9"> 75</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#a6950adb7dd9a398ddca523c9542a5ad9">get</a>( <a class="code hl_typedef" href="group__qtypes.html#ga958a9c1f540e61e60e7893fccccf1d51">byte_t</a> *dst ) <span class="keyword">noexcept</span>;</div> |
|
193 | 196 | <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classq_o_s_1_1byte_buffer.html#afcc85e15c7179199fc99557826d55f63"> 98</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classq_o_s_1_1byte_buffer.html#afcc85e15c7179199fc99557826d55f63">count</a>( <span class="keywordtype">void</span> ) <span class="keyword">const</span> <span class="keyword">noexcept</span>;</div> |
194 | 197 | <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> };</div> |
195 | 198 | </div> |
196 | | -<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div> |
| 199 | +<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span></div> |
197 | 200 | <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>}</div> |
198 | 201 | </div> |
199 | 202 | <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div> |
200 | 203 | <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div> |
201 | 204 | <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="preprocessor">#endif </span><span class="comment">/*QOS_BYTE_BUFFER*/</span><span class="preprocessor"></span></div> |
202 | | -<div class="ttc" id="aclassq_o_s_1_1byte_buffer_html"><div class="ttname"><a href="classq_o_s_1_1byte_buffer.html">qOS::byteBuffer</a></div><div class="ttdoc">A Byte-sized buffer object.</div><div class="ttdef"><b>Definition</b> bytebuffer.hpp:17</div></div> |
203 | 205 | <div class="ttc" id="aclassq_o_s_1_1byte_buffer_html_a51fd9989f0dc93b24adf4ac6710bbb45"><div class="ttname"><a href="classq_o_s_1_1byte_buffer.html#a51fd9989f0dc93b24adf4ac6710bbb45">qOS::byteBuffer::isFull</a></div><div class="ttdeci">bool isFull(void) const noexcept</div><div class="ttdoc">Query the full status of the Byte-sized buffer.</div></div> |
204 | 206 | <div class="ttc" id="aclassq_o_s_1_1byte_buffer_html_a528582b1fa4c0a60d27926617aa3e57e"><div class="ttname"><a href="classq_o_s_1_1byte_buffer.html#a528582b1fa4c0a60d27926617aa3e57e">qOS::byteBuffer::setup</a></div><div class="ttdeci">bool setup(volatile byte_t(&area)[numberOfBytes]) noexcept</div><div class="ttdef"><b>Definition</b> bytebuffer.hpp:52</div></div> |
205 | 207 | <div class="ttc" id="aclassq_o_s_1_1byte_buffer_html_a5606af1fab73ee13728d33d306cc1d41"><div class="ttname"><a href="classq_o_s_1_1byte_buffer.html#a5606af1fab73ee13728d33d306cc1d41">qOS::byteBuffer::read</a></div><div class="ttdeci">bool read(void *dst, const size_t n) noexcept</div><div class="ttdoc">Gets n data from the Byte-sized buffer and removes them.</div></div> |
|
220 | 222 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
221 | 223 | <ul> |
222 | 224 | <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><b>bytebuffer.hpp</b></li> |
223 | | - <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li> |
| 225 | + <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li> |
224 | 226 | </ul> |
225 | 227 | </div> |
226 | 228 | </body> |
|
0 commit comments