-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclasssst_1_1cpputils_1_1SimpleRingBuffer.html
More file actions
344 lines (321 loc) · 27.3 KB
/
classsst_1_1cpputils_1_1SimpleRingBuffer.html
File metadata and controls
344 lines (321 loc) · 27.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
<!-- HTML header for doxygen 1.8.15-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>sst-cpputils: SimpleRingBuffer< T, N, MemoryOrder > Class Template Reference</title>
<link rel="shortcut icon" href="logo.png" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-115384200-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-115384200-1');
</script>
<!-- END Global site tag - Google Analytics -->
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px; padding-top: 5px; padding-bottom: 5px;">
<td id="projectlogo"><a href="https://github.com/surge-synthesizer/sst-cpputils"><img alt="Logo" style="width: 100%; height: 100%" src="logo.png"/></a></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">sst-cpputils
<!-- BEGIN PROJECT_NUMBER <span id="projectnumber">1.0.0</span>END PROJECT_NUMBER-->
</div>
<div id="projectbrief">CPP Utilities submodule from the Surge Synth Team</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesst.html">sst</a></li><li class="navelem"><a class="el" href="namespacesst_1_1cpputils.html">cpputils</a></li><li class="navelem"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html">SimpleRingBuffer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classsst_1_1cpputils_1_1SimpleRingBuffer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SimpleRingBuffer< T, N, MemoryOrder > Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <ring_buffer.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SimpleRingBuffer< T, N, MemoryOrder >:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classsst_1_1cpputils_1_1SimpleRingBuffer__inherit__graph.png" border="0" usemap="#aSimpleRingBuffer_3_01T_00_01N_00_01MemoryOrder_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aSimpleRingBuffer_3_01T_00_01N_00_01MemoryOrder_01_4_inherit__map" id="aSimpleRingBuffer_3_01T_00_01N_00_01MemoryOrder_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,93,168,133"/>
<area shape="rect" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html" title=" " alt="" coords="7,5,167,45"/>
<area shape="poly" title=" " alt="" coords="89,59,89,93,84,93,84,59"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a265a253612b46abed17c61b0a5e5ce30" id="r_a265a253612b46abed17c61b0a5e5ce30"><td class="memItemLeft" align="right" valign="top">typedef T </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a265a253612b46abed17c61b0a5e5ce30">value_type</a></td></tr>
<tr class="separator:a265a253612b46abed17c61b0a5e5ce30"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a16fd6af771d250b4fe7f107f29dede61" id="r_a16fd6af771d250b4fe7f107f29dede61"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a16fd6af771d250b4fe7f107f29dede61">SimpleRingBuffer</a> ()</td></tr>
<tr class="separator:a16fd6af771d250b4fe7f107f29dede61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44a53147d4b3600ec200300ea16e3707" id="r_a44a53147d4b3600ec200300ea16e3707"><td class="memItemLeft" align="right" valign="top">std::optional< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a44a53147d4b3600ec200300ea16e3707">pop</a> ()</td></tr>
<tr class="separator:a44a53147d4b3600ec200300ea16e3707"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a849946b194bd368ad8e51226a52be35a" id="r_a849946b194bd368ad8e51226a52be35a"><td class="memItemLeft" align="right" valign="top">std::vector< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a849946b194bd368ad8e51226a52be35a">popall</a> ()</td></tr>
<tr class="separator:a849946b194bd368ad8e51226a52be35a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17e66675f4136b857fdbbbc902fca2c2" id="r_a17e66675f4136b857fdbbbc902fca2c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a17e66675f4136b857fdbbbc902fca2c2">push</a> (T unit)</td></tr>
<tr class="separator:a17e66675f4136b857fdbbbc902fca2c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d068d122ab231a962edd1ed3507f294" id="r_a1d068d122ab231a962edd1ed3507f294"><td class="memTemplParams" colspan="2">template<typename U = T> </td></tr>
<tr class="memitem:a1d068d122ab231a962edd1ed3507f294"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t< std::is_copy_constructible_v< U > > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a1d068d122ab231a962edd1ed3507f294">push</a> (const T *units, std::size_t sz)</td></tr>
<tr class="separator:a1d068d122ab231a962edd1ed3507f294"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1f06edaa48c0d18f8bf1664ec88c75e" id="r_af1f06edaa48c0d18f8bf1664ec88c75e"><td class="memTemplParams" colspan="2">template<typename U = T> </td></tr>
<tr class="memitem:af1f06edaa48c0d18f8bf1664ec88c75e"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t< std::is_copy_constructible_v< U > > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#af1f06edaa48c0d18f8bf1664ec88c75e">push</a> (const std::vector< T > &v)</td></tr>
<tr class="separator:af1f06edaa48c0d18f8bf1664ec88c75e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html">RingBufferInternal< N, MemoryOrder ></a></td></tr>
<tr class="memitem:a87ff845c4556e170437df782b086aa42 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a87ff845c4556e170437df782b086aa42"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a87ff845c4556e170437df782b086aa42">RingBufferInternal</a> ()</td></tr>
<tr class="separator:a87ff845c4556e170437df782b086aa42 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f37b042a1e7cd4bd38fc564de81f0da inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a3f37b042a1e7cd4bd38fc564de81f0da"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a3f37b042a1e7cd4bd38fc564de81f0da">empty</a> ()</td></tr>
<tr class="separator:a3f37b042a1e7cd4bd38fc564de81f0da inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee37e9309344d91a82e996b2e7fb905e inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_aee37e9309344d91a82e996b2e7fb905e"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#aee37e9309344d91a82e996b2e7fb905e">size</a> ()</td></tr>
<tr class="separator:aee37e9309344d91a82e996b2e7fb905e inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bccd94c4239c019c480e507cb6159ee inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a0bccd94c4239c019c480e507cb6159ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a0bccd94c4239c019c480e507cb6159ee">subscribe</a> ()</td></tr>
<tr class="separator:a0bccd94c4239c019c480e507cb6159ee inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04fc89aa31e530fde28909fa75cdef76 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a04fc89aa31e530fde28909fa75cdef76"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a04fc89aa31e530fde28909fa75cdef76">unsubscribe</a> ()</td></tr>
<tr class="separator:a04fc89aa31e530fde28909fa75cdef76 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bbca55d6c8f234990c4f78bf4449288 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a0bbca55d6c8f234990c4f78bf4449288"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a0bbca55d6c8f234990c4f78bf4449288">subscribed</a> () const</td></tr>
<tr class="separator:a0bbca55d6c8f234990c4f78bf4449288 inherit pub_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html">RingBufferInternal< N, MemoryOrder ></a></td></tr>
<tr class="memitem:ab1a152915916afa70c2dc91689eedcb2 inherit pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_ab1a152915916afa70c2dc91689eedcb2"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ab1a152915916afa70c2dc91689eedcb2">mask</a> (std::size_t val)</td></tr>
<tr class="separator:ab1a152915916afa70c2dc91689eedcb2 inherit pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d051e633a8f39dfc4d7c8ff52a6eb48 inherit pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a3d051e633a8f39dfc4d7c8ff52a6eb48"><td class="memItemLeft" align="right" valign="top">std::pair< std::size_t, std::size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a3d051e633a8f39dfc4d7c8ff52a6eb48">prepareToRead</a> (std::size_t count) const</td></tr>
<tr class="separator:a3d051e633a8f39dfc4d7c8ff52a6eb48 inherit pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87eae1fcc7ed35a9312156a4a11e722a inherit pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a87eae1fcc7ed35a9312156a4a11e722a"><td class="memItemLeft" align="right" valign="top">std::tuple< std::size_t, std::size_t, std::size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a87eae1fcc7ed35a9312156a4a11e722a">prepareToWrite</a> (std::size_t count) const</td></tr>
<tr class="separator:a87eae1fcc7ed35a9312156a4a11e722a inherit pro_methods_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html">RingBufferInternal< N, MemoryOrder ></a></td></tr>
<tr class="memitem:ab81de6f906b300d008c118a4fa0d37a3 inherit pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_ab81de6f906b300d008c118a4fa0d37a3"><td class="memItemLeft" align="right" valign="top">std::atomic_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ab81de6f906b300d008c118a4fa0d37a3">subscribed_</a></td></tr>
<tr class="separator:ab81de6f906b300d008c118a4fa0d37a3 inherit pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26121752602b260ef411d84766757e81 inherit pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_a26121752602b260ef411d84766757e81"><td class="memItemLeft" align="right" valign="top">std::atomic_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a26121752602b260ef411d84766757e81">writePos_</a></td></tr>
<tr class="separator:a26121752602b260ef411d84766757e81 inherit pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5bbdd05f08f7c53aefdfe9aa981c4c8 inherit pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal" id="r_aa5bbdd05f08f7c53aefdfe9aa981c4c8"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#aa5bbdd05f08f7c53aefdfe9aa981c4c8">readPos_</a></td></tr>
<tr class="separator:aa5bbdd05f08f7c53aefdfe9aa981c4c8 inherit pro_attribs_classsst_1_1cpputils_1_1internal_1_1RingBufferInternal"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a265a253612b46abed17c61b0a5e5ce30" name="a265a253612b46abed17c61b0a5e5ce30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a265a253612b46abed17c61b0a5e5ce30">◆ </a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<table class="memname">
<tr>
<td class="memname">typedef T <a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a265a253612b46abed17c61b0a5e5ce30">value_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a16fd6af771d250b4fe7f107f29dede61" name="a16fd6af771d250b4fe7f107f29dede61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16fd6af771d250b4fe7f107f29dede61">◆ </a></span>SimpleRingBuffer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html">SimpleRingBuffer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a44a53147d4b3600ec200300ea16e3707" name="a44a53147d4b3600ec200300ea16e3707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44a53147d4b3600ec200300ea16e3707">◆ </a></span>pop()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<table class="memname">
<tr>
<td class="memname">std::optional< T > pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ab1a152915916afa70c2dc91689eedcb2">RingBufferInternal< N, MemoryOrder >::mask()</a>, <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#aa5bbdd05f08f7c53aefdfe9aa981c4c8">RingBufferInternal< N, MemoryOrder >::readPos_</a>, and <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a26121752602b260ef411d84766757e81">RingBufferInternal< N, MemoryOrder >::writePos_</a>.</p>
</div>
</div>
<a id="a849946b194bd368ad8e51226a52be35a" name="a849946b194bd368ad8e51226a52be35a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a849946b194bd368ad8e51226a52be35a">◆ </a></span>popall()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<table class="memname">
<tr>
<td class="memname">std::vector< T > popall </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ab1a152915916afa70c2dc91689eedcb2">RingBufferInternal< N, MemoryOrder >::mask()</a>, <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a3d051e633a8f39dfc4d7c8ff52a6eb48">RingBufferInternal< N, MemoryOrder >::prepareToRead()</a>, <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#aa5bbdd05f08f7c53aefdfe9aa981c4c8">RingBufferInternal< N, MemoryOrder >::readPos_</a>, and <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a26121752602b260ef411d84766757e81">RingBufferInternal< N, MemoryOrder >::writePos_</a>.</p>
</div>
</div>
<a id="a17e66675f4136b857fdbbbc902fca2c2" name="a17e66675f4136b857fdbbbc902fca2c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e66675f4136b857fdbbbc902fca2c2">◆ </a></span>push() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<table class="memname">
<tr>
<td class="memname">void push </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"><em>unit</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ab1a152915916afa70c2dc91689eedcb2">RingBufferInternal< N, MemoryOrder >::mask()</a>, and <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a26121752602b260ef411d84766757e81">RingBufferInternal< N, MemoryOrder >::writePos_</a>.</p>
<p class="reference">Referenced by <a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#af1f06edaa48c0d18f8bf1664ec88c75e">SimpleRingBuffer< T, N, MemoryOrder >::push()</a>.</p>
</div>
</div>
<a id="a1d068d122ab231a962edd1ed3507f294" name="a1d068d122ab231a962edd1ed3507f294"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d068d122ab231a962edd1ed3507f294">◆ </a></span>push() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<div class="memtemplate">
template<typename U = T> </div>
<table class="memname">
<tr>
<td class="memname">std::enable_if_t< std::is_copy_constructible_v< U > > push </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>units</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"><em>sz</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#ab1a152915916afa70c2dc91689eedcb2">RingBufferInternal< N, MemoryOrder >::mask()</a>, <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a87eae1fcc7ed35a9312156a4a11e722a">RingBufferInternal< N, MemoryOrder >::prepareToWrite()</a>, and <a class="el" href="classsst_1_1cpputils_1_1internal_1_1RingBufferInternal.html#a26121752602b260ef411d84766757e81">RingBufferInternal< N, MemoryOrder >::writePos_</a>.</p>
</div>
</div>
<a id="af1f06edaa48c0d18f8bf1664ec88c75e" name="af1f06edaa48c0d18f8bf1664ec88c75e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1f06edaa48c0d18f8bf1664ec88c75e">◆ </a></span>push() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T , std::size_t N, std::memory_order MemoryOrder = std::memory_order_relaxed> </div>
<div class="memtemplate">
template<typename U = T> </div>
<table class="memname">
<tr>
<td class="memname">std::enable_if_t< std::is_copy_constructible_v< U > > push </td>
<td>(</td>
<td class="paramtype">const std::vector< T > & </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">References <a class="el" href="classsst_1_1cpputils_1_1SimpleRingBuffer.html#a17e66675f4136b857fdbbbc902fca2c2">SimpleRingBuffer< T, N, MemoryOrder >::push()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ring__buffer_8h.html">ring_buffer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 20 2026 00:23:27 for sst-cpputils by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>