-
Notifications
You must be signed in to change notification settings - Fork 81
Expand file tree
/
Copy pathringbuffer_8h.html
More file actions
588 lines (560 loc) · 30.6 KB
/
ringbuffer_8h.html
File metadata and controls
588 lines (560 loc) · 30.6 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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
<!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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JACK-AUDIO-CONNECTION-KIT: ringbuffer.h File Reference</title>
<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/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</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;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JACK-AUDIO-CONNECTION-KIT
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3e6ff996e0a05d442d13220a8cf7408f.html">jack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ringbuffer.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <sys/types.h></code><br />
</div>
<p><a href="ringbuffer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a11f9045eb4b0561b26ec434c44e3c922"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a11f9045eb4b0561b26ec434c44e3c922">jack_ringbuffer_create</a> (size_t sz)</td></tr>
<tr class="separator:a11f9045eb4b0561b26ec434c44e3c922"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa82de39e73e06aa729e092710b83ef61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#aa82de39e73e06aa729e092710b83ef61">jack_ringbuffer_free</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb)</td></tr>
<tr class="separator:aa82de39e73e06aa729e092710b83ef61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa21aaf8ff173ba0e89b35554f20d4ccb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#aa21aaf8ff173ba0e89b35554f20d4ccb">jack_ringbuffer_get_read_vector</a> (const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> *vec)</td></tr>
<tr class="separator:aa21aaf8ff173ba0e89b35554f20d4ccb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c44a50c99f43bb683d8721f14aefc7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a1c44a50c99f43bb683d8721f14aefc7d">jack_ringbuffer_get_write_vector</a> (const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, <a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> *vec)</td></tr>
<tr class="separator:a1c44a50c99f43bb683d8721f14aefc7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b001e5844a116a1d51006e2716c73bb"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a4b001e5844a116a1d51006e2716c73bb">jack_ringbuffer_read</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, char *dest, size_t cnt)</td></tr>
<tr class="separator:a4b001e5844a116a1d51006e2716c73bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad268f29e641b39bee8155e7e80ad4520"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#ad268f29e641b39bee8155e7e80ad4520">jack_ringbuffer_peek</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, char *dest, size_t cnt)</td></tr>
<tr class="separator:ad268f29e641b39bee8155e7e80ad4520"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9cdd4b69ae338c6ce464a1de00ee71a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#aa9cdd4b69ae338c6ce464a1de00ee71a">jack_ringbuffer_read_advance</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, size_t cnt)</td></tr>
<tr class="separator:aa9cdd4b69ae338c6ce464a1de00ee71a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61e93fa7c9bfb6897dd2508d026d9317"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a61e93fa7c9bfb6897dd2508d026d9317">jack_ringbuffer_read_space</a> (const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb)</td></tr>
<tr class="separator:a61e93fa7c9bfb6897dd2508d026d9317"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb059ff23c65389d48ebbe948f05c2b2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#aeb059ff23c65389d48ebbe948f05c2b2">jack_ringbuffer_mlock</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb)</td></tr>
<tr class="separator:aeb059ff23c65389d48ebbe948f05c2b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40244c7eee331822cd99132a14e76896"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a40244c7eee331822cd99132a14e76896">jack_ringbuffer_reset</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb)</td></tr>
<tr class="separator:a40244c7eee331822cd99132a14e76896"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d2fc75510e4df62f5b3dd249047b132"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a6d2fc75510e4df62f5b3dd249047b132">jack_ringbuffer_write</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, const char *src, size_t cnt)</td></tr>
<tr class="separator:a6d2fc75510e4df62f5b3dd249047b132"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7255e067e485770d8127d821b6d7e9ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a7255e067e485770d8127d821b6d7e9ec">jack_ringbuffer_write_advance</a> (<a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb, size_t cnt)</td></tr>
<tr class="separator:a7255e067e485770d8127d821b6d7e9ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07a5f6086380300b7b2ccfd7cf9c2ef6"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ringbuffer_8h.html#a07a5f6086380300b7b2ccfd7cf9c2ef6">jack_ringbuffer_write_space</a> (const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> *rb)</td></tr>
<tr class="separator:a07a5f6086380300b7b2ccfd7cf9c2ef6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A set of library functions to make lock-free ringbuffers available to JACK clients. The ‘capture_client.c’ (in the example_clients directory) is a fully functioning user of this API.</p>
<p>The key attribute of a ringbuffer is that it can be safely accessed by two threads simultaneously – one reading from the buffer and the other writing to it – without using any synchronization or mutual exclusion primitives. For this to work correctly, there can only be a single reader and a single writer thread. Their identities cannot be interchanged. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a11f9045eb4b0561b26ec434c44e3c922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11f9045eb4b0561b26ec434c44e3c922">◆ </a></span>jack_ringbuffer_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a>* jack_ringbuffer_create </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>sz</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a ringbuffer data structure of a specified size. The caller must arrange for a call to <a class="el" href="ringbuffer_8h.html#aa82de39e73e06aa729e092710b83ef61">jack_ringbuffer_free()</a> to release the memory associated with the ringbuffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sz</td><td>the ringbuffer size in bytes.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a new <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a>, if successful; NULL otherwise. </dd></dl>
</div>
</div>
<a id="aa82de39e73e06aa729e092710b83ef61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa82de39e73e06aa729e092710b83ef61">◆ </a></span>jack_ringbuffer_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_ringbuffer_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees the ringbuffer data structure allocated by an earlier call to <a class="el" href="ringbuffer_8h.html#a11f9045eb4b0561b26ec434c44e3c922">jack_ringbuffer_create()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa21aaf8ff173ba0e89b35554f20d4ccb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa21aaf8ff173ba0e89b35554f20d4ccb">◆ </a></span>jack_ringbuffer_get_read_vector()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_ringbuffer_get_read_vector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> * </td>
<td class="paramname"><em>vec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fill a data structure with a description of the current readable data held in the ringbuffer. This description is returned in a two element array of <a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a>. Two elements are needed because the data to be read may be split across the end of the ringbuffer.</p>
<p>The first element will always contain a valid <em>len</em> field, which may be zero or greater. If the <em>len</em> field is non-zero, then data can be read in a contiguous fashion using the address given in the corresponding <em>buf</em> field.</p>
<p>If the second element has a non-zero <em>len</em> field, then a second contiguous stretch of data can be read from the address given in its corresponding <em>buf</em> field.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">vec</td><td>a pointer to a 2 element array of <a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1c44a50c99f43bb683d8721f14aefc7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c44a50c99f43bb683d8721f14aefc7d">◆ </a></span>jack_ringbuffer_get_write_vector()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_ringbuffer_get_write_vector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a> * </td>
<td class="paramname"><em>vec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fill a data structure with a description of the current writable space in the ringbuffer. The description is returned in a two element array of <a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a>. Two elements are needed because the space available for writing may be split across the end of the ringbuffer.</p>
<p>The first element will always contain a valid <em>len</em> field, which may be zero or greater. If the <em>len</em> field is non-zero, then data can be written in a contiguous fashion using the address given in the corresponding <em>buf</em> field.</p>
<p>If the second element has a non-zero <em>len</em> field, then a second contiguous stretch of data can be written to the address given in the corresponding <em>buf</em> field.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">vec</td><td>a pointer to a 2 element array of <a class="el" href="structjack__ringbuffer__data__t.html">jack_ringbuffer_data_t</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeb059ff23c65389d48ebbe948f05c2b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb059ff23c65389d48ebbe948f05c2b2">◆ </a></span>jack_ringbuffer_mlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int jack_ringbuffer_mlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lock a ringbuffer data block into memory.</p>
<p>Uses the mlock() system call. This is not a realtime operation.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad268f29e641b39bee8155e7e80ad4520"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad268f29e641b39bee8155e7e80ad4520">◆ </a></span>jack_ringbuffer_peek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t jack_ringbuffer_peek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the ringbuffer. Opposed to <a class="el" href="ringbuffer_8h.html#a4b001e5844a116a1d51006e2716c73bb">jack_ringbuffer_read()</a> this function does not move the read pointer. Thus it's a convenient way to inspect data in the ringbuffer in a continous fashion. The price is that the data is copied into a user provided buffer. For "raw" non-copy inspection of the data in the ringbuffer use <a class="el" href="ringbuffer_8h.html#aa21aaf8ff173ba0e89b35554f20d4ccb">jack_ringbuffer_get_read_vector()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">dest</td><td>a pointer to a buffer where data read from the ringbuffer will go. </td></tr>
<tr><td class="paramname">cnt</td><td>the number of bytes to read.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read, which may range from 0 to cnt. </dd></dl>
</div>
</div>
<a id="a4b001e5844a116a1d51006e2716c73bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b001e5844a116a1d51006e2716c73bb">◆ </a></span>jack_ringbuffer_read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t jack_ringbuffer_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the ringbuffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">dest</td><td>a pointer to a buffer where data read from the ringbuffer will go. </td></tr>
<tr><td class="paramname">cnt</td><td>the number of bytes to read.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes read, which may range from 0 to cnt. </dd></dl>
</div>
</div>
<a id="aa9cdd4b69ae338c6ce464a1de00ee71a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9cdd4b69ae338c6ce464a1de00ee71a">◆ </a></span>jack_ringbuffer_read_advance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_ringbuffer_read_advance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the read pointer.</p>
<p>After data have been read from the ringbuffer using the pointers returned by <a class="el" href="ringbuffer_8h.html#aa21aaf8ff173ba0e89b35554f20d4ccb">jack_ringbuffer_get_read_vector()</a>, use this function to advance the buffer pointers, making that space available for future write operations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">cnt</td><td>the number of bytes read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a61e93fa7c9bfb6897dd2508d026d9317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61e93fa7c9bfb6897dd2508d026d9317">◆ </a></span>jack_ringbuffer_read_space()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t jack_ringbuffer_read_space </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of bytes available for reading.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes available to read. </dd></dl>
</div>
</div>
<a id="a40244c7eee331822cd99132a14e76896"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40244c7eee331822cd99132a14e76896">◆ </a></span>jack_ringbuffer_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_ringbuffer_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the read and write pointers, making an empty buffer.</p>
<p>This is not thread safe.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6d2fc75510e4df62f5b3dd249047b132"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d2fc75510e4df62f5b3dd249047b132">◆ </a></span>jack_ringbuffer_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t jack_ringbuffer_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data into the ringbuffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">src</td><td>a pointer to the data to be written to the ringbuffer. </td></tr>
<tr><td class="paramname">cnt</td><td>the number of bytes to write.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes write, which may range from 0 to cnt </dd></dl>
</div>
</div>
<a id="a7255e067e485770d8127d821b6d7e9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7255e067e485770d8127d821b6d7e9ec">◆ </a></span>jack_ringbuffer_write_advance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jack_ringbuffer_write_advance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cnt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the write pointer.</p>
<p>After data have been written the ringbuffer using the pointers returned by <a class="el" href="ringbuffer_8h.html#a1c44a50c99f43bb683d8721f14aefc7d">jack_ringbuffer_get_write_vector()</a>, use this function to advance the buffer pointer, making the data available for future read operations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure. </td></tr>
<tr><td class="paramname">cnt</td><td>the number of bytes written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a07a5f6086380300b7b2ccfd7cf9c2ef6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07a5f6086380300b7b2ccfd7cf9c2ef6">◆ </a></span>jack_ringbuffer_write_space()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t jack_ringbuffer_write_space </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structjack__ringbuffer__t.html">jack_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of bytes available for writing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>a pointer to the ringbuffer structure.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the amount of free space (in bytes) available for writing. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>