DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classRingBufferControl.html

396 lines
27KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: RingBufferControl&lt; BufferStruct &gt; Class Template Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</script>

  47. <div id="main-nav"></div>

  48. <!-- window showing the filter options -->

  49. <div id="MSearchSelectWindow"

  50.      onmouseover="return searchBox.OnSearchSelectShow()"

  51.      onmouseout="return searchBox.OnSearchSelectHide()"

  52.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  53. </div>

  54. 

  55. <!-- iframe showing the search results (closed by default) -->

  56. <div id="MSearchResultsWindow">

  57. <iframe src="javascript:void(0)" frameborder="0" 

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

  62. </div><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="#pro-methods">Protected Member Functions</a> &#124;

  67. <a href="classRingBufferControl-members.html">List of all members</a>  </div>

  68.   <div class="headertitle">

  69. <div class="title">RingBufferControl&lt; BufferStruct &gt; Class Template Reference</div>  </div>

  70. </div><!--header-->

  71. <div class="contents">

  72. 

  73. <p><code>#include &lt;<a class="el" href="RingBuffer_8hpp_source.html">RingBuffer.hpp</a>&gt;</code></p>

  74. <table class="memberdecls">

  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  76. Public Member Functions</h2></td></tr>

  77. <tr class="memitem:a5a857b3ce6d8570899e1310bbaa166c2"><td class="memItemLeft" align="right" valign="top"><a id="a5a857b3ce6d8570899e1310bbaa166c2"></a>

  78. bool&#160;</td><td class="memItemRight" valign="bottom"><b>isDataAvailableForReading</b> () const noexcept</td></tr>

  79. <tr class="separator:a5a857b3ce6d8570899e1310bbaa166c2"><td class="memSeparator" colspan="2">&#160;</td></tr>

  80. <tr class="memitem:ac795fc07ffa5c591b9516b514dedc7aa"><td class="memItemLeft" align="right" valign="top"><a id="ac795fc07ffa5c591b9516b514dedc7aa"></a>

  81. bool&#160;</td><td class="memItemRight" valign="bottom"><b>isEmpty</b> () const noexcept</td></tr>

  82. <tr class="separator:ac795fc07ffa5c591b9516b514dedc7aa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  83. <tr class="memitem:a904c3d96f7c501357bde107392307746"><td class="memItemLeft" align="right" valign="top"><a id="a904c3d96f7c501357bde107392307746"></a>

  84. uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>getSize</b> () const noexcept</td></tr>

  85. <tr class="separator:a904c3d96f7c501357bde107392307746"><td class="memSeparator" colspan="2">&#160;</td></tr>

  86. <tr class="memitem:a798dea2af126ea7749d4325e401d6b90"><td class="memItemLeft" align="right" valign="top"><a id="a798dea2af126ea7749d4325e401d6b90"></a>

  87. uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>getReadableDataSize</b> () const noexcept</td></tr>

  88. <tr class="separator:a798dea2af126ea7749d4325e401d6b90"><td class="memSeparator" colspan="2">&#160;</td></tr>

  89. <tr class="memitem:ac6882674f4bdfb7bc8d9c3a89e6a3275"><td class="memItemLeft" align="right" valign="top"><a id="ac6882674f4bdfb7bc8d9c3a89e6a3275"></a>

  90. uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>getWritableDataSize</b> () const noexcept</td></tr>

  91. <tr class="separator:ac6882674f4bdfb7bc8d9c3a89e6a3275"><td class="memSeparator" colspan="2">&#160;</td></tr>

  92. <tr class="memitem:a8a93880bd798351b66c7c546ee91d7af"><td class="memItemLeft" align="right" valign="top"><a id="a8a93880bd798351b66c7c546ee91d7af"></a>

  93. void&#160;</td><td class="memItemRight" valign="bottom"><b>clearData</b> () noexcept</td></tr>

  94. <tr class="separator:a8a93880bd798351b66c7c546ee91d7af"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <tr class="memitem:a84cf5dece61cf5d0a3050eb4d757f072"><td class="memItemLeft" align="right" valign="top"><a id="a84cf5dece61cf5d0a3050eb4d757f072"></a>

  96. void&#160;</td><td class="memItemRight" valign="bottom"><b>flush</b> () noexcept</td></tr>

  97. <tr class="separator:a84cf5dece61cf5d0a3050eb4d757f072"><td class="memSeparator" colspan="2">&#160;</td></tr>

  98. <tr class="memitem:a7861a13bc22c3a692490002e11cfa001"><td class="memItemLeft" align="right" valign="top"><a id="a7861a13bc22c3a692490002e11cfa001"></a>

  99. bool&#160;</td><td class="memItemRight" valign="bottom"><b>readBool</b> () noexcept</td></tr>

  100. <tr class="separator:a7861a13bc22c3a692490002e11cfa001"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <tr class="memitem:a7b08be900bb851cb08ea17797afde52b"><td class="memItemLeft" align="right" valign="top"><a id="a7b08be900bb851cb08ea17797afde52b"></a>

  102. uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>readByte</b> () noexcept</td></tr>

  103. <tr class="separator:a7b08be900bb851cb08ea17797afde52b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  104. <tr class="memitem:a481ba7979e8dfa0077225fb4eeedcdf4"><td class="memItemLeft" align="right" valign="top"><a id="a481ba7979e8dfa0077225fb4eeedcdf4"></a>

  105. int16_t&#160;</td><td class="memItemRight" valign="bottom"><b>readShort</b> () noexcept</td></tr>

  106. <tr class="separator:a481ba7979e8dfa0077225fb4eeedcdf4"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <tr class="memitem:a3a568b35da8271fd136d3e52254c3a6e"><td class="memItemLeft" align="right" valign="top"><a id="a3a568b35da8271fd136d3e52254c3a6e"></a>

  108. uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>readUShort</b> () noexcept</td></tr>

  109. <tr class="separator:a3a568b35da8271fd136d3e52254c3a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  110. <tr class="memitem:a6f9f287326a852f40dc8c2f477eac61d"><td class="memItemLeft" align="right" valign="top"><a id="a6f9f287326a852f40dc8c2f477eac61d"></a>

  111. int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>readInt</b> () noexcept</td></tr>

  112. <tr class="separator:a6f9f287326a852f40dc8c2f477eac61d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <tr class="memitem:a8cb216fe6c4ae7955f7a1e6fde3fdaaa"><td class="memItemLeft" align="right" valign="top"><a id="a8cb216fe6c4ae7955f7a1e6fde3fdaaa"></a>

  114. uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>readUInt</b> () noexcept</td></tr>

  115. <tr class="separator:a8cb216fe6c4ae7955f7a1e6fde3fdaaa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  116. <tr class="memitem:a00e4069c4e71a15aba05cbd20416f9c2"><td class="memItemLeft" align="right" valign="top"><a id="a00e4069c4e71a15aba05cbd20416f9c2"></a>

  117. int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readLong</b> () noexcept</td></tr>

  118. <tr class="separator:a00e4069c4e71a15aba05cbd20416f9c2"><td class="memSeparator" colspan="2">&#160;</td></tr>

  119. <tr class="memitem:a84d06ef9f64dda3c61e02744bee598b5"><td class="memItemLeft" align="right" valign="top"><a id="a84d06ef9f64dda3c61e02744bee598b5"></a>

  120. uint64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readULong</b> () noexcept</td></tr>

  121. <tr class="separator:a84d06ef9f64dda3c61e02744bee598b5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <tr class="memitem:a0cfb2a83c9788607530c96e122f1a5cb"><td class="memItemLeft" align="right" valign="top"><a id="a0cfb2a83c9788607530c96e122f1a5cb"></a>

  123. float&#160;</td><td class="memItemRight" valign="bottom"><b>readFloat</b> () noexcept</td></tr>

  124. <tr class="separator:a0cfb2a83c9788607530c96e122f1a5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>

  125. <tr class="memitem:a4181c35249c1cfa5115836766552a9f7"><td class="memItemLeft" align="right" valign="top"><a id="a4181c35249c1cfa5115836766552a9f7"></a>

  126. double&#160;</td><td class="memItemRight" valign="bottom"><b>readDouble</b> () noexcept</td></tr>

  127. <tr class="separator:a4181c35249c1cfa5115836766552a9f7"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. <tr class="memitem:aafdb126b2885c507cec852bc63fd6cb8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRingBufferControl.html#aafdb126b2885c507cec852bc63fd6cb8">readCustomData</a> (void *const data, const uint32_t size) noexcept</td></tr>

  129. <tr class="separator:aafdb126b2885c507cec852bc63fd6cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <tr class="memitem:aaaf4efe13ec2555c390047f545d2660d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  131. <tr class="memitem:aaaf4efe13ec2555c390047f545d2660d"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRingBufferControl.html#aaaf4efe13ec2555c390047f545d2660d">readCustomType</a> (T &amp;type) noexcept</td></tr>

  132. <tr class="separator:aaaf4efe13ec2555c390047f545d2660d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  133. <tr class="memitem:a8d560bf7255bf3f9b3ab91d178c8a514"><td class="memItemLeft" align="right" valign="top"><a id="a8d560bf7255bf3f9b3ab91d178c8a514"></a>

  134. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeBool</b> (const bool value) noexcept</td></tr>

  135. <tr class="separator:a8d560bf7255bf3f9b3ab91d178c8a514"><td class="memSeparator" colspan="2">&#160;</td></tr>

  136. <tr class="memitem:a57d59476536b91746d8bf52bfae74755"><td class="memItemLeft" align="right" valign="top"><a id="a57d59476536b91746d8bf52bfae74755"></a>

  137. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeByte</b> (const uint8_t value) noexcept</td></tr>

  138. <tr class="separator:a57d59476536b91746d8bf52bfae74755"><td class="memSeparator" colspan="2">&#160;</td></tr>

  139. <tr class="memitem:a05763b20c7a59eab5b9ec7f32c758954"><td class="memItemLeft" align="right" valign="top"><a id="a05763b20c7a59eab5b9ec7f32c758954"></a>

  140. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeShort</b> (const int16_t value) noexcept</td></tr>

  141. <tr class="separator:a05763b20c7a59eab5b9ec7f32c758954"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <tr class="memitem:a9b4e2008d32cf8ae36cbce37db935fa0"><td class="memItemLeft" align="right" valign="top"><a id="a9b4e2008d32cf8ae36cbce37db935fa0"></a>

  143. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeUShort</b> (const uint16_t value) noexcept</td></tr>

  144. <tr class="separator:a9b4e2008d32cf8ae36cbce37db935fa0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  145. <tr class="memitem:a55d6d467fbb82ec942eaa88ee9de056f"><td class="memItemLeft" align="right" valign="top"><a id="a55d6d467fbb82ec942eaa88ee9de056f"></a>

  146. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeInt</b> (const int32_t value) noexcept</td></tr>

  147. <tr class="separator:a55d6d467fbb82ec942eaa88ee9de056f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. <tr class="memitem:a3b3e0c77afe562049ebef1a5dd534ffe"><td class="memItemLeft" align="right" valign="top"><a id="a3b3e0c77afe562049ebef1a5dd534ffe"></a>

  149. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeUInt</b> (const uint32_t value) noexcept</td></tr>

  150. <tr class="separator:a3b3e0c77afe562049ebef1a5dd534ffe"><td class="memSeparator" colspan="2">&#160;</td></tr>

  151. <tr class="memitem:a5400bbf87025d3f6b4bf307538eacd8e"><td class="memItemLeft" align="right" valign="top"><a id="a5400bbf87025d3f6b4bf307538eacd8e"></a>

  152. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeLong</b> (const int64_t value) noexcept</td></tr>

  153. <tr class="separator:a5400bbf87025d3f6b4bf307538eacd8e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  154. <tr class="memitem:ac2bc16d54ac5d10065124719abb95a87"><td class="memItemLeft" align="right" valign="top"><a id="ac2bc16d54ac5d10065124719abb95a87"></a>

  155. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeULong</b> (const uint64_t value) noexcept</td></tr>

  156. <tr class="separator:ac2bc16d54ac5d10065124719abb95a87"><td class="memSeparator" colspan="2">&#160;</td></tr>

  157. <tr class="memitem:a97f63ccaa7e578346938b32dfb47224e"><td class="memItemLeft" align="right" valign="top"><a id="a97f63ccaa7e578346938b32dfb47224e"></a>

  158. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeFloat</b> (const float value) noexcept</td></tr>

  159. <tr class="separator:a97f63ccaa7e578346938b32dfb47224e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  160. <tr class="memitem:a6ad016c6ff0e3b3469060ad5ca758e73"><td class="memItemLeft" align="right" valign="top"><a id="a6ad016c6ff0e3b3469060ad5ca758e73"></a>

  161. bool&#160;</td><td class="memItemRight" valign="bottom"><b>writeDouble</b> (const double value) noexcept</td></tr>

  162. <tr class="separator:a6ad016c6ff0e3b3469060ad5ca758e73"><td class="memSeparator" colspan="2">&#160;</td></tr>

  163. <tr class="memitem:a72e173dcae573f6e2e8ac4cfeb8aa96b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRingBufferControl.html#a72e173dcae573f6e2e8ac4cfeb8aa96b">writeCustomData</a> (const void *const data, const uint32_t size) noexcept</td></tr>

  164. <tr class="separator:a72e173dcae573f6e2e8ac4cfeb8aa96b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  165. <tr class="memitem:a3e9c1857e11f0d9efcc2944d6000504b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>

  166. <tr class="memitem:a3e9c1857e11f0d9efcc2944d6000504b"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRingBufferControl.html#a3e9c1857e11f0d9efcc2944d6000504b">writeCustomType</a> (const T &amp;type) noexcept</td></tr>

  167. <tr class="separator:a3e9c1857e11f0d9efcc2944d6000504b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  168. <tr class="memitem:afe0c53d2591eb265d657c1cab6800036"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRingBufferControl.html#afe0c53d2591eb265d657c1cab6800036">commitWrite</a> () noexcept</td></tr>

  169. <tr class="separator:afe0c53d2591eb265d657c1cab6800036"><td class="memSeparator" colspan="2">&#160;</td></tr>

  170. <tr class="memitem:ac1d302eb13fa5f41a2f9cb94974f2355"><td class="memItemLeft" align="right" valign="top"><a id="ac1d302eb13fa5f41a2f9cb94974f2355"></a>

  171. void&#160;</td><td class="memItemRight" valign="bottom"><b>setRingBuffer</b> (BufferStruct *const ringBuf, const bool clearRingBufferData) noexcept</td></tr>

  172. <tr class="separator:ac1d302eb13fa5f41a2f9cb94974f2355"><td class="memSeparator" colspan="2">&#160;</td></tr>

  173. </table><table class="memberdecls">

  174. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  175. Protected Member Functions</h2></td></tr>

  176. <tr class="memitem:ae52a43afbe6404494aeb2abfb305342b"><td class="memItemLeft" align="right" valign="top"><a id="ae52a43afbe6404494aeb2abfb305342b"></a>

  177. bool&#160;</td><td class="memItemRight" valign="bottom"><b>tryRead</b> (void *const buf, const uint32_t size) noexcept</td></tr>

  178. <tr class="separator:ae52a43afbe6404494aeb2abfb305342b"><td class="memSeparator" colspan="2">&#160;</td></tr>

  179. <tr class="memitem:a121bc17537c3ff7841d8e684e84fbb7a"><td class="memItemLeft" align="right" valign="top"><a id="a121bc17537c3ff7841d8e684e84fbb7a"></a>

  180. bool&#160;</td><td class="memItemRight" valign="bottom"><b>tryWrite</b> (const void *const buf, const uint32_t size) noexcept</td></tr>

  181. <tr class="separator:a121bc17537c3ff7841d8e684e84fbb7a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  182. </table>

  183. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  184. <div class="textblock"><h3>template&lt;class BufferStruct&gt;<br />

  185. class RingBufferControl&lt; BufferStruct &gt;</h3>

  186. 

  187. <p>DPF built-in RingBuffer class. <a class="el" href="classRingBufferControl.html">RingBufferControl</a> takes one buffer struct to take control over, and operates over it.</p>

  188. <p>This is meant for single-writer, single-reader type of control. Writing and reading is wait and lock-free.</p>

  189. <p>Typically usage involves: </p><div class="fragment"><div class="line"><span class="comment">// definition</span></div>

  190. <div class="line"><a class="code" href="classHeapRingBuffer.html">HeapRingBuffer</a> myHeapBuffer; <span class="comment">// or RingBufferControl&lt;HeapBuffer&gt; class for more control</span></div>

  191. <div class="line"> </div>

  192. <div class="line"><span class="comment">// construction, only needed for heap buffers</span></div>

  193. <div class="line">myHeapBuffer.<a class="code" href="classHeapRingBuffer.html#ab7d60a3acc757e88e1c7254626ce9709">createBuffer</a>(8192);</div>

  194. <div class="line"> </div>

  195. <div class="line"><span class="comment">// writing data</span></div>

  196. <div class="line">myHeapBuffer.writeUInt(size);</div>

  197. <div class="line">myHeapBuffer.<a class="code" href="classRingBufferControl.html#a72e173dcae573f6e2e8ac4cfeb8aa96b">writeCustomData</a>(someOtherData, size);</div>

  198. <div class="line">myHeapBuffer.<a class="code" href="classRingBufferControl.html#afe0c53d2591eb265d657c1cab6800036">commitWrite</a>();</div>

  199. <div class="line"> </div>

  200. <div class="line"><span class="comment">// reading data</span></div>

  201. <div class="line"><span class="keywordflow">if</span> (myHeapBuffer.isDataAvailableForReading())</div>

  202. <div class="line">{</div>

  203. <div class="line">   uint32_t size;</div>

  204. <div class="line">   <span class="keywordflow">if</span> (myHeapBuffer.readUInt(size) &amp;&amp; <a class="code" href="classRingBufferControl.html#aafdb126b2885c507cec852bc63fd6cb8">readCustomData</a>(&amp;anotherData, size))</div>

  205. <div class="line">   {</div>

  206. <div class="line">       <span class="comment">// do something with &quot;anotherData&quot;</span></div>

  207. <div class="line">   }</div>

  208. <div class="line">}</div>

  209. <div class="ttc" id="aclassHeapRingBuffer_html"><div class="ttname"><a href="classHeapRingBuffer.html">HeapRingBuffer</a></div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:711</div></div>

  210. <div class="ttc" id="aclassHeapRingBuffer_html_ab7d60a3acc757e88e1c7254626ce9709"><div class="ttname"><a href="classHeapRingBuffer.html#ab7d60a3acc757e88e1c7254626ce9709">HeapRingBuffer::createBuffer</a></div><div class="ttdeci">bool createBuffer(const uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:733</div></div>

  211. <div class="ttc" id="aclassRingBufferControl_html_a72e173dcae573f6e2e8ac4cfeb8aa96b"><div class="ttname"><a href="classRingBufferControl.html#a72e173dcae573f6e2e8ac4cfeb8aa96b">RingBufferControl::writeCustomData</a></div><div class="ttdeci">bool writeCustomData(const void *const data, const uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:494</div></div>

  212. <div class="ttc" id="aclassRingBufferControl_html_aafdb126b2885c507cec852bc63fd6cb8"><div class="ttname"><a href="classRingBufferControl.html#aafdb126b2885c507cec852bc63fd6cb8">RingBufferControl::readCustomData</a></div><div class="ttdeci">bool readCustomData(void *const data, const uint32_t size) noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:378</div></div>

  213. <div class="ttc" id="aclassRingBufferControl_html_afe0c53d2591eb265d657c1cab6800036"><div class="ttname"><a href="classRingBufferControl.html#afe0c53d2591eb265d657c1cab6800036">RingBufferControl::commitWrite</a></div><div class="ttdeci">bool commitWrite() noexcept</div><div class="ttdef"><b>Definition:</b> RingBuffer.hpp:518</div></div>

  214. </div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="structHeapBuffer.html">HeapBuffer</a> </dd></dl>

  215. </div><h2 class="groupheader">Member Function Documentation</h2>

  216. <a id="aafdb126b2885c507cec852bc63fd6cb8"></a>

  217. <h2 class="memtitle"><span class="permalink"><a href="#aafdb126b2885c507cec852bc63fd6cb8">&#9670;&nbsp;</a></span>readCustomData()</h2>

  218. 

  219. <div class="memitem">

  220. <div class="memproto">

  221. <div class="memtemplate">

  222. template&lt;class BufferStruct &gt; </div>

  223. <table class="mlabels">

  224.   <tr>

  225.   <td class="mlabels-left">

  226.       <table class="memname">

  227.         <tr>

  228.           <td class="memname">bool <a class="el" href="classRingBufferControl.html">RingBufferControl</a>&lt; BufferStruct &gt;::readCustomData </td>

  229.           <td>(</td>

  230.           <td class="paramtype">void *const&#160;</td>

  231.           <td class="paramname"><em>data</em>, </td>

  232.         </tr>

  233.         <tr>

  234.           <td class="paramkey"></td>

  235.           <td></td>

  236.           <td class="paramtype">const uint32_t&#160;</td>

  237.           <td class="paramname"><em>size</em>&#160;</td>

  238.         </tr>

  239.         <tr>

  240.           <td></td>

  241.           <td>)</td>

  242.           <td></td><td></td>

  243.         </tr>

  244.       </table>

  245.   </td>

  246.   <td class="mlabels-right">

  247. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  248.   </tr>

  249. </table>

  250. </div><div class="memdoc">

  251. <p>Read an arbitrary amount of data, specified by <em>size</em>. data pointer must be non-null, and size &gt; 0.</p>

  252. <p>Returns true if reading succeeds. In case of failure, <em>data</em> pointer is automatically cleared by <em>size</em> bytes. </p>

  253. 

  254. </div>

  255. </div>

  256. <a id="aaaf4efe13ec2555c390047f545d2660d"></a>

  257. <h2 class="memtitle"><span class="permalink"><a href="#aaaf4efe13ec2555c390047f545d2660d">&#9670;&nbsp;</a></span>readCustomType()</h2>

  258. 

  259. <div class="memitem">

  260. <div class="memproto">

  261. <div class="memtemplate">

  262. template&lt;class BufferStruct &gt; </div>

  263. <div class="memtemplate">

  264. template&lt;typename T &gt; </div>

  265. <table class="mlabels">

  266.   <tr>

  267.   <td class="mlabels-left">

  268.       <table class="memname">

  269.         <tr>

  270.           <td class="memname">bool <a class="el" href="classRingBufferControl.html">RingBufferControl</a>&lt; BufferStruct &gt;::readCustomType </td>

  271.           <td>(</td>

  272.           <td class="paramtype">T &amp;&#160;</td>

  273.           <td class="paramname"><em>type</em></td><td>)</td>

  274.           <td></td>

  275.         </tr>

  276.       </table>

  277.   </td>

  278.   <td class="mlabels-right">

  279. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  280.   </tr>

  281. </table>

  282. </div><div class="memdoc">

  283. <p>Read a custom data type specified by the template typename used, with size being automatically deduced by the compiler (through the use of sizeof).</p>

  284. <p>Returns true if reading succeeds. In case of failure, <em>type</em> value is automatically cleared by its deduced size. </p>

  285. 

  286. </div>

  287. </div>

  288. <a id="a72e173dcae573f6e2e8ac4cfeb8aa96b"></a>

  289. <h2 class="memtitle"><span class="permalink"><a href="#a72e173dcae573f6e2e8ac4cfeb8aa96b">&#9670;&nbsp;</a></span>writeCustomData()</h2>

  290. 

  291. <div class="memitem">

  292. <div class="memproto">

  293. <div class="memtemplate">

  294. template&lt;class BufferStruct &gt; </div>

  295. <table class="mlabels">

  296.   <tr>

  297.   <td class="mlabels-left">

  298.       <table class="memname">

  299.         <tr>

  300.           <td class="memname">bool <a class="el" href="classRingBufferControl.html">RingBufferControl</a>&lt; BufferStruct &gt;::writeCustomData </td>

  301.           <td>(</td>

  302.           <td class="paramtype">const void *const&#160;</td>

  303.           <td class="paramname"><em>data</em>, </td>

  304.         </tr>

  305.         <tr>

  306.           <td class="paramkey"></td>

  307.           <td></td>

  308.           <td class="paramtype">const uint32_t&#160;</td>

  309.           <td class="paramname"><em>size</em>&#160;</td>

  310.         </tr>

  311.         <tr>

  312.           <td></td>

  313.           <td>)</td>

  314.           <td></td><td></td>

  315.         </tr>

  316.       </table>

  317.   </td>

  318.   <td class="mlabels-right">

  319. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  320.   </tr>

  321. </table>

  322. </div><div class="memdoc">

  323. <p>Write an arbitrary amount of data, specified by <em>size</em>. data pointer must be non-null, and size &gt; 0. </p>

  324. 

  325. </div>

  326. </div>

  327. <a id="a3e9c1857e11f0d9efcc2944d6000504b"></a>

  328. <h2 class="memtitle"><span class="permalink"><a href="#a3e9c1857e11f0d9efcc2944d6000504b">&#9670;&nbsp;</a></span>writeCustomType()</h2>

  329. 

  330. <div class="memitem">

  331. <div class="memproto">

  332. <div class="memtemplate">

  333. template&lt;class BufferStruct &gt; </div>

  334. <div class="memtemplate">

  335. template&lt;typename T &gt; </div>

  336. <table class="mlabels">

  337.   <tr>

  338.   <td class="mlabels-left">

  339.       <table class="memname">

  340.         <tr>

  341.           <td class="memname">bool <a class="el" href="classRingBufferControl.html">RingBufferControl</a>&lt; BufferStruct &gt;::writeCustomType </td>

  342.           <td>(</td>

  343.           <td class="paramtype">const T &amp;&#160;</td>

  344.           <td class="paramname"><em>type</em></td><td>)</td>

  345.           <td></td>

  346.         </tr>

  347.       </table>

  348.   </td>

  349.   <td class="mlabels-right">

  350. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  351.   </tr>

  352. </table>

  353. </div><div class="memdoc">

  354. <p>Write a custom data type specified by the template typename used, with size being automatically deduced by the compiler (through the use of sizeof). </p>

  355. 

  356. </div>

  357. </div>

  358. <a id="afe0c53d2591eb265d657c1cab6800036"></a>

  359. <h2 class="memtitle"><span class="permalink"><a href="#afe0c53d2591eb265d657c1cab6800036">&#9670;&nbsp;</a></span>commitWrite()</h2>

  360. 

  361. <div class="memitem">

  362. <div class="memproto">

  363. <div class="memtemplate">

  364. template&lt;class BufferStruct &gt; </div>

  365. <table class="mlabels">

  366.   <tr>

  367.   <td class="mlabels-left">

  368.       <table class="memname">

  369.         <tr>

  370.           <td class="memname">bool <a class="el" href="classRingBufferControl.html">RingBufferControl</a>&lt; BufferStruct &gt;::commitWrite </td>

  371.           <td>(</td>

  372.           <td class="paramname"></td><td>)</td>

  373.           <td></td>

  374.         </tr>

  375.       </table>

  376.   </td>

  377.   <td class="mlabels-right">

  378. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  379.   </tr>

  380. </table>

  381. </div><div class="memdoc">

  382. <p>Commit all previous write operations to the ringbuffer. If a write operation has previously failed, this will reset/invalidate the previous write attempts. </p>

  383. 

  384. </div>

  385. </div>

  386. <hr/>The documentation for this class was generated from the following file:<ul>

  387. <li>distrho/extra/<a class="el" href="RingBuffer_8hpp_source.html">RingBuffer.hpp</a></li>

  388. </ul>

  389. </div><!-- contents -->

  390. <!-- start footer part -->

  391. <hr class="footer"/><address class="footer"><small>

  392. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  393. </small></address>

  394. </body>

  395. </html>