/usr/share/doc/libqb-dev/html/qbrb_8h.html is in libqb-doc 1.0.1-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libqb: qbrb.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>
<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">libqb
 <span id="projectnumber">1.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_99176029e6245da7be482686d42cbcde.html">qb</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">qbrb.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This implements a ring buffer that works in "chunks" not bytes.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <sys/types.h></code><br />
<code>#include <stdint.h></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for qbrb.h:</div>
<div class="dyncontent">
<div class="center"><img src="qbrb_8h__incl.png" border="0" usemap="#qbrb_8h" alt=""/></div>
<map name="qbrb_8h" id="qbrb_8h">
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3bf2613790c34f1da4da7e5d28b9f418"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a3bf2613790c34f1da4da7e5d28b9f418">QB_RB_FLAG_CREATE</a>   0x01</td></tr>
<tr class="memdesc:a3bf2613790c34f1da4da7e5d28b9f418"><td class="mdescLeft"> </td><td class="mdescRight">create a ring buffer (rather than open and existing one) <a href="#a3bf2613790c34f1da4da7e5d28b9f418">More...</a><br /></td></tr>
<tr class="separator:a3bf2613790c34f1da4da7e5d28b9f418"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1857ecabb97a65d157bbc5ccaa536d9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#ac1857ecabb97a65d157bbc5ccaa536d9">QB_RB_FLAG_OVERWRITE</a>   0x02</td></tr>
<tr class="memdesc:ac1857ecabb97a65d157bbc5ccaa536d9"><td class="mdescLeft"> </td><td class="mdescRight">New calls to <a class="el" href="qbrb_8h.html#a6be2cb75d70f5befe605501721086121" title="Write a chunk to the ring buffer. ">qb_rb_chunk_write()</a> will call <a class="el" href="qbrb_8h.html#aea4e369c61625edfad2bda86165725c0" title="Reclaim the oldest chunk. ">qb_rb_chunk_reclaim()</a> if there is not enough space. <a href="#ac1857ecabb97a65d157bbc5ccaa536d9">More...</a><br /></td></tr>
<tr class="separator:ac1857ecabb97a65d157bbc5ccaa536d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdb866bfc44855b73e4404f6526ce5ad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#afdb866bfc44855b73e4404f6526ce5ad">QB_RB_FLAG_SHARED_THREAD</a>   0x04</td></tr>
<tr class="memdesc:afdb866bfc44855b73e4404f6526ce5ad"><td class="mdescLeft"> </td><td class="mdescRight">The ringbuffer will be shared between pthreads not processes. <a href="#afdb866bfc44855b73e4404f6526ce5ad">More...</a><br /></td></tr>
<tr class="separator:afdb866bfc44855b73e4404f6526ce5ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac893c2640e8291e6229a227a861c760c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#ac893c2640e8291e6229a227a861c760c">QB_RB_FLAG_SHARED_PROCESS</a>   0x08</td></tr>
<tr class="memdesc:ac893c2640e8291e6229a227a861c760c"><td class="mdescLeft"> </td><td class="mdescRight">The ringbuffer will be shared between processes. <a href="#ac893c2640e8291e6229a227a861c760c">More...</a><br /></td></tr>
<tr class="separator:ac893c2640e8291e6229a227a861c760c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a9796b3ce0f4ea6fd710697058bb87c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a2a9796b3ce0f4ea6fd710697058bb87c">QB_RB_FLAG_NO_SEMAPHORE</a>   0x10</td></tr>
<tr class="memdesc:a2a9796b3ce0f4ea6fd710697058bb87c"><td class="mdescLeft"> </td><td class="mdescRight">Don't use semaphores, only atomic ops. <a href="#a2a9796b3ce0f4ea6fd710697058bb87c">More...</a><br /></td></tr>
<tr class="separator:a2a9796b3ce0f4ea6fd710697058bb87c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa73b885fa2fbda5dfe4f374e4e0ae0da"><td class="memItemLeft" align="right" valign="top">typedef struct qb_ringbuffer_s </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a></td></tr>
<tr class="separator:aa73b885fa2fbda5dfe4f374e4e0ae0da"><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:ad7f0ee52204d491ddb6c5adf88e38c31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31">qb_rb_open</a> (const char *name, size_t size, uint32_t flags, size_t shared_user_data_size)</td></tr>
<tr class="memdesc:ad7f0ee52204d491ddb6c5adf88e38c31"><td class="mdescLeft"> </td><td class="mdescRight">Create the ring buffer with the given type. <a href="#ad7f0ee52204d491ddb6c5adf88e38c31">More...</a><br /></td></tr>
<tr class="separator:ad7f0ee52204d491ddb6c5adf88e38c31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a676646fa5f7d2dba585a92b99f91a84c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a676646fa5f7d2dba585a92b99f91a84c">qb_rb_close</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:a676646fa5f7d2dba585a92b99f91a84c"><td class="mdescLeft"> </td><td class="mdescRight">Dereference the ringbuffer and if we are the last user destroy it. <a href="#a676646fa5f7d2dba585a92b99f91a84c">More...</a><br /></td></tr>
<tr class="separator:a676646fa5f7d2dba585a92b99f91a84c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aedda1312afff053ccbfddbd074351641"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aedda1312afff053ccbfddbd074351641">qb_rb_name_get</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:aedda1312afff053ccbfddbd074351641"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the ringbuffer. <a href="#aedda1312afff053ccbfddbd074351641">More...</a><br /></td></tr>
<tr class="separator:aedda1312afff053ccbfddbd074351641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa18f8ca651e8ef29b43a311e280aee37"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aa18f8ca651e8ef29b43a311e280aee37">qb_rb_shared_user_data_get</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:aa18f8ca651e8ef29b43a311e280aee37"><td class="mdescLeft"> </td><td class="mdescRight">Get a point to user shared data area. <a href="#aa18f8ca651e8ef29b43a311e280aee37">More...</a><br /></td></tr>
<tr class="separator:aa18f8ca651e8ef29b43a311e280aee37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6be2cb75d70f5befe605501721086121"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a6be2cb75d70f5befe605501721086121">qb_rb_chunk_write</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, const void *data, size_t len)</td></tr>
<tr class="memdesc:a6be2cb75d70f5befe605501721086121"><td class="mdescLeft"> </td><td class="mdescRight">Write a chunk to the ring buffer. <a href="#a6be2cb75d70f5befe605501721086121">More...</a><br /></td></tr>
<tr class="separator:a6be2cb75d70f5befe605501721086121"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0e73503e8dc50e3cad1022bb740ef6c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#ae0e73503e8dc50e3cad1022bb740ef6c">qb_rb_chunk_alloc</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, size_t len)</td></tr>
<tr class="memdesc:ae0e73503e8dc50e3cad1022bb740ef6c"><td class="mdescLeft"> </td><td class="mdescRight">Allocate space for a chunk of the given size. <a href="#ae0e73503e8dc50e3cad1022bb740ef6c">More...</a><br /></td></tr>
<tr class="separator:ae0e73503e8dc50e3cad1022bb740ef6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0be62e0deea17d91292e2a84f6d864b9"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a0be62e0deea17d91292e2a84f6d864b9">qb_rb_chunk_commit</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, size_t len)</td></tr>
<tr class="memdesc:a0be62e0deea17d91292e2a84f6d864b9"><td class="mdescLeft"> </td><td class="mdescRight">finalize the chunk. <a href="#a0be62e0deea17d91292e2a84f6d864b9">More...</a><br /></td></tr>
<tr class="separator:a0be62e0deea17d91292e2a84f6d864b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec633cc7fee08c5c73445fab3edc9d44"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aec633cc7fee08c5c73445fab3edc9d44">qb_rb_chunk_peek</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, void **data_out, int32_t ms_timeout)</td></tr>
<tr class="memdesc:aec633cc7fee08c5c73445fab3edc9d44"><td class="mdescLeft"> </td><td class="mdescRight">Read (without reclaiming) the last chunk. <a href="#aec633cc7fee08c5c73445fab3edc9d44">More...</a><br /></td></tr>
<tr class="separator:aec633cc7fee08c5c73445fab3edc9d44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea4e369c61625edfad2bda86165725c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aea4e369c61625edfad2bda86165725c0">qb_rb_chunk_reclaim</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:aea4e369c61625edfad2bda86165725c0"><td class="mdescLeft"> </td><td class="mdescRight">Reclaim the oldest chunk. <a href="#aea4e369c61625edfad2bda86165725c0">More...</a><br /></td></tr>
<tr class="separator:aea4e369c61625edfad2bda86165725c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaeb042cad040e561093604ce5050f85b"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aaeb042cad040e561093604ce5050f85b">qb_rb_chunk_read</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, void *data_out, size_t len, int32_t ms_timeout)</td></tr>
<tr class="memdesc:aaeb042cad040e561093604ce5050f85b"><td class="mdescLeft"> </td><td class="mdescRight">Read the oldest chunk into data_out. <a href="#aaeb042cad040e561093604ce5050f85b">More...</a><br /></td></tr>
<tr class="separator:aaeb042cad040e561093604ce5050f85b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe1712513305a610df664f0b8a382d95"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#abe1712513305a610df664f0b8a382d95">qb_rb_refcount_get</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:abe1712513305a610df664f0b8a382d95"><td class="mdescLeft"> </td><td class="mdescRight">Get the reference count. <a href="#abe1712513305a610df664f0b8a382d95">More...</a><br /></td></tr>
<tr class="separator:abe1712513305a610df664f0b8a382d95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e6b26f1c15cbd4050a9487e4399757c"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a0e6b26f1c15cbd4050a9487e4399757c">qb_rb_space_free</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:a0e6b26f1c15cbd4050a9487e4399757c"><td class="mdescLeft"> </td><td class="mdescRight">The amount of free space in the ring buffer. <a href="#a0e6b26f1c15cbd4050a9487e4399757c">More...</a><br /></td></tr>
<tr class="separator:a0e6b26f1c15cbd4050a9487e4399757c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3aec2cca1b640d73c35efdcb545225f9"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a3aec2cca1b640d73c35efdcb545225f9">qb_rb_space_used</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:a3aec2cca1b640d73c35efdcb545225f9"><td class="mdescLeft"> </td><td class="mdescRight">The total amount of data in the buffer. <a href="#a3aec2cca1b640d73c35efdcb545225f9">More...</a><br /></td></tr>
<tr class="separator:a3aec2cca1b640d73c35efdcb545225f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a961e46671f346f94fefa0690a12a9d71"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a961e46671f346f94fefa0690a12a9d71">qb_rb_chunks_used</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb)</td></tr>
<tr class="memdesc:a961e46671f346f94fefa0690a12a9d71"><td class="mdescLeft"> </td><td class="mdescRight">The total number of chunks in the buffer. <a href="#a961e46671f346f94fefa0690a12a9d71">More...</a><br /></td></tr>
<tr class="separator:a961e46671f346f94fefa0690a12a9d71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53a05bc0ced76b97f38be38bfd4ee19f"><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a53a05bc0ced76b97f38be38bfd4ee19f">qb_rb_write_to_file</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, int32_t fd)</td></tr>
<tr class="memdesc:a53a05bc0ced76b97f38be38bfd4ee19f"><td class="mdescLeft"> </td><td class="mdescRight">Write the contents of the Ring Buffer to file. <a href="#a53a05bc0ced76b97f38be38bfd4ee19f">More...</a><br /></td></tr>
<tr class="separator:a53a05bc0ced76b97f38be38bfd4ee19f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaccf9973a435866fcddd937a2ad8f90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#aeaccf9973a435866fcddd937a2ad8f90">qb_rb_create_from_file</a> (int32_t fd, uint32_t flags)</td></tr>
<tr class="memdesc:aeaccf9973a435866fcddd937a2ad8f90"><td class="mdescLeft"> </td><td class="mdescRight">Load the saved ring buffer from file into tempory memory. <a href="#aeaccf9973a435866fcddd937a2ad8f90">More...</a><br /></td></tr>
<tr class="separator:aeaccf9973a435866fcddd937a2ad8f90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6266e10354c068267cf33ef349ceffb7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a6266e10354c068267cf33ef349ceffb7">qb_rb_chown</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, uid_t owner, gid_t group)</td></tr>
<tr class="memdesc:a6266e10354c068267cf33ef349ceffb7"><td class="mdescLeft"> </td><td class="mdescRight">Like 'chown' it changes the owner and group of the ringbuffers resources. <a href="#a6266e10354c068267cf33ef349ceffb7">More...</a><br /></td></tr>
<tr class="separator:a6266e10354c068267cf33ef349ceffb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cb8a90e13ee826b60c93a4b5bbecc64"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="qbrb_8h.html#a8cb8a90e13ee826b60c93a4b5bbecc64">qb_rb_chmod</a> (<a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> *rb, mode_t mode)</td></tr>
<tr class="memdesc:a8cb8a90e13ee826b60c93a4b5bbecc64"><td class="mdescLeft"> </td><td class="mdescRight">Like 'chmod' it changes the mode of the ringbuffers resources. <a href="#a8cb8a90e13ee826b60c93a4b5bbecc64">More...</a><br /></td></tr>
<tr class="separator:a8cb8a90e13ee826b60c93a4b5bbecc64"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This implements a ring buffer that works in "chunks" not bytes. </p>
<p>So you write/read a complete chunk or not at all. There are two types of ring buffer normal and overwrite. Overwrite will reclaim the oldest chunks inorder to make way for new ones, the normal version will refuse to write a new chunk if the ring buffer is full.</p>
<p>This implementation is capable of working across processes, but one process must only write and the other prrocess read.</p>
<p>The read process will do the following: </p><div class="fragment"><div class="line">rb = <a class="code" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31">qb_rb_open</a>(<span class="stringliteral">"test2"</span>, 2000, <a class="code" href="qbrb_8h.html#ac893c2640e8291e6229a227a861c760c">QB_RB_FLAG_SHARED_PROCESS</a>|<a class="code" href="qbrb_8h.html#a3bf2613790c34f1da4da7e5d28b9f418">QB_RB_FLAG_CREATE</a>);</div><div class="line"><span class="keywordflow">for</span> (i = 0; i < 200; i++) {</div><div class="line">try_read_again:</div><div class="line"> l = <a class="code" href="qbrb_8h.html#aaeb042cad040e561093604ce5050f85b">qb_rb_chunk_read</a>(rb, (<span class="keywordtype">void</span> *)out, 32, 1000);</div><div class="line"> <span class="keywordflow">if</span> (l < 0) {</div><div class="line"> <span class="keywordflow">goto</span> try_read_again;</div><div class="line"> }</div><div class="line">}</div><div class="line">...</div><div class="line">qb_rb_close(rb);</div></div><!-- fragment --><p>The write process will do the following: </p><div class="fragment"><div class="line"> rb = <a class="code" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31">qb_rb_open</a>(<span class="stringliteral">"test2"</span>, 2000, <a class="code" href="qbrb_8h.html#ac893c2640e8291e6229a227a861c760c">QB_RB_FLAG_SHARED_PROCESS</a>);</div><div class="line"> <span class="keywordflow">for</span> (i = 0; i < 200; i++) {</div><div class="line">try_write_again:</div><div class="line"> l = <a class="code" href="qbrb_8h.html#a6be2cb75d70f5befe605501721086121">qb_rb_chunk_write</a>(rb, &v, <span class="keyword">sizeof</span>(v));</div><div class="line"> <span class="keywordflow">if</span> (l < <span class="keyword">sizeof</span>(v)) {</div><div class="line"> <span class="keywordflow">goto</span> try_write_again;</div><div class="line"> }</div><div class="line"> }</div><div class="line"> ...</div><div class="line"> <a class="code" href="qbrb_8h.html#a676646fa5f7d2dba585a92b99f91a84c">qb_rb_close</a>(rb);</div></div><!-- fragment --><dl class="section author"><dt>Author</dt><dd>Angus Salkeld <a href="#" onclick="location.href='mai'+'lto:'+'asa'+'lk'+'eld'+'@r'+'edh'+'at'+'.co'+'m'; return false;">asalk<span style="display: none;">.nosp@m.</span>eld@<span style="display: none;">.nosp@m.</span>redha<span style="display: none;">.nosp@m.</span>t.co<span style="display: none;">.nosp@m.</span>m</a> </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a3bf2613790c34f1da4da7e5d28b9f418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bf2613790c34f1da4da7e5d28b9f418">◆ </a></span>QB_RB_FLAG_CREATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QB_RB_FLAG_CREATE   0x01</td>
</tr>
</table>
</div><div class="memdoc">
<p>create a ring buffer (rather than open and existing one) </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31" title="Create the ring buffer with the given type. ">qb_rb_open()</a> </dd></dl>
</div>
</div>
<a id="a2a9796b3ce0f4ea6fd710697058bb87c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a9796b3ce0f4ea6fd710697058bb87c">◆ </a></span>QB_RB_FLAG_NO_SEMAPHORE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QB_RB_FLAG_NO_SEMAPHORE   0x10</td>
</tr>
</table>
</div><div class="memdoc">
<p>Don't use semaphores, only atomic ops. </p>
<p>This mean that the timeout passed into <a class="el" href="qbrb_8h.html#aaeb042cad040e561093604ce5050f85b" title="Read the oldest chunk into data_out. ">qb_rb_chunk_read()</a> will be ignored. </p>
</div>
</div>
<a id="ac1857ecabb97a65d157bbc5ccaa536d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1857ecabb97a65d157bbc5ccaa536d9">◆ </a></span>QB_RB_FLAG_OVERWRITE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QB_RB_FLAG_OVERWRITE   0x02</td>
</tr>
</table>
</div><div class="memdoc">
<p>New calls to <a class="el" href="qbrb_8h.html#a6be2cb75d70f5befe605501721086121" title="Write a chunk to the ring buffer. ">qb_rb_chunk_write()</a> will call <a class="el" href="qbrb_8h.html#aea4e369c61625edfad2bda86165725c0" title="Reclaim the oldest chunk. ">qb_rb_chunk_reclaim()</a> if there is not enough space. </p>
<p>If this is not set then new writes will be refused. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31" title="Create the ring buffer with the given type. ">qb_rb_open()</a> </dd></dl>
</div>
</div>
<a id="ac893c2640e8291e6229a227a861c760c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac893c2640e8291e6229a227a861c760c">◆ </a></span>QB_RB_FLAG_SHARED_PROCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QB_RB_FLAG_SHARED_PROCESS   0x08</td>
</tr>
</table>
</div><div class="memdoc">
<p>The ringbuffer will be shared between processes. </p>
<p>This effects the type of locks/semaphores that are used. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31" title="Create the ring buffer with the given type. ">qb_rb_open()</a> </dd></dl>
</div>
</div>
<a id="afdb866bfc44855b73e4404f6526ce5ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdb866bfc44855b73e4404f6526ce5ad">◆ </a></span>QB_RB_FLAG_SHARED_THREAD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define QB_RB_FLAG_SHARED_THREAD   0x04</td>
</tr>
</table>
</div><div class="memdoc">
<p>The ringbuffer will be shared between pthreads not processes. </p>
<p>This effects the type of locks/semaphores that are used. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31" title="Create the ring buffer with the given type. ">qb_rb_open()</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aa73b885fa2fbda5dfe4f374e4e0ae0da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa73b885fa2fbda5dfe4f374e4e0ae0da">◆ </a></span>qb_ringbuffer_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct qb_ringbuffer_s <a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8cb8a90e13ee826b60c93a4b5bbecc64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cb8a90e13ee826b60c93a4b5bbecc64">◆ </a></span>qb_rb_chmod()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t qb_rb_chmod </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">mode_t </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Like 'chmod' it changes the mode of the ringbuffers resources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>mode to change to </td></tr>
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">0</td><td>== ok </td></tr>
<tr><td class="paramname">-errno</td><td>for error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6266e10354c068267cf33ef349ceffb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6266e10354c068267cf33ef349ceffb7">◆ </a></span>qb_rb_chown()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t qb_rb_chown </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uid_t </td>
<td class="paramname"><em>owner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gid_t </td>
<td class="paramname"><em>group</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Like 'chown' it changes the owner and group of the ringbuffers resources. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">owner</td><td>uid of the owner to change to </td></tr>
<tr><td class="paramname">group</td><td>gid of the group to change to </td></tr>
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status (0 = ok, -errno for error) </dd></dl>
</div>
</div>
<a id="ae0e73503e8dc50e3cad1022bb740ef6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0e73503e8dc50e3cad1022bb740ef6c">◆ </a></span>qb_rb_chunk_alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* qb_rb_chunk_alloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_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>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate space for a chunk of the given size. </p>
<p>If type == QB_RB_FLAG_OVERWRITE and NULL is returned, memory corruption of the memory file has occured. The ringbuffer should be destroyed. If type == QB_RB_NORMAL then when there is not enough space it will return NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
<tr><td class="paramname">len</td><td>(in) the size to allocate. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to chunk to write to, or NULL (if no space).</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#ae0e73503e8dc50e3cad1022bb740ef6c" title="Allocate space for a chunk of the given size. ">qb_rb_chunk_alloc()</a> </dd></dl>
</div>
</div>
<a id="a0be62e0deea17d91292e2a84f6d864b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0be62e0deea17d91292e2a84f6d864b9">◆ </a></span>qb_rb_chunk_commit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t qb_rb_chunk_commit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_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>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>finalize the chunk. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
<tr><td class="paramname">len</td><td>(in) the size of the chunk. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aec633cc7fee08c5c73445fab3edc9d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec633cc7fee08c5c73445fab3edc9d44">◆ </a></span>qb_rb_chunk_peek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_chunk_peek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>data_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>ms_timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read (without reclaiming) the last chunk. </p>
<p>This function is a way of accessing the next chunk without a memcpy(). You can read the chunk data in place.</p>
<dl class="section note"><dt>Note</dt><dd>This function will not "pop" the chunk, you will need to call <a class="el" href="qbrb_8h.html#aea4e369c61625edfad2bda86165725c0" title="Reclaim the oldest chunk. ">qb_rb_chunk_reclaim()</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
<tr><td class="paramname">data_out</td><td>(out) a pointer to the next chunk to read (not copied). </td></tr>
<tr><td class="paramname">ms_timeout</td><td>(in) time to wait for new data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the size of the chunk (0 if buffer empty). </dd></dl>
</div>
</div>
<a id="aaeb042cad040e561093604ce5050f85b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeb042cad040e561093604ce5050f85b">◆ </a></span>qb_rb_chunk_read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_chunk_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data_out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>ms_timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the oldest chunk into data_out. </p>
<p>This is the same as <a class="el" href="qbrb_8h.html#aec633cc7fee08c5c73445fab3edc9d44" title="Read (without reclaiming) the last chunk. ">qb_rb_chunk_peek()</a> memcpy() and <a class="el" href="qbrb_8h.html#aea4e369c61625edfad2bda86165725c0" title="Reclaim the oldest chunk. ">qb_rb_chunk_reclaim()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
<tr><td class="paramname">data_out</td><td>(in/out) the chunk will be memcpy'ed into this. </td></tr>
<tr><td class="paramname">len</td><td>(in) the size of data_out. </td></tr>
<tr><td class="paramname">ms_timeout</td><td>the amount od time to wait for new data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the size of the chunk, or error. </dd></dl>
</div>
</div>
<a id="aea4e369c61625edfad2bda86165725c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea4e369c61625edfad2bda86165725c0">◆ </a></span>qb_rb_chunk_reclaim()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qb_rb_chunk_reclaim </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reclaim the oldest chunk. </p>
<p>You will need to call this if using <a class="el" href="qbrb_8h.html#aec633cc7fee08c5c73445fab3edc9d44" title="Read (without reclaiming) the last chunk. ">qb_rb_chunk_peek()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6be2cb75d70f5befe605501721086121"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6be2cb75d70f5befe605501721086121">◆ </a></span>qb_rb_chunk_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_chunk_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a chunk to the ring buffer. </p>
<p>This simply calls <a class="el" href="qbrb_8h.html#ae0e73503e8dc50e3cad1022bb740ef6c" title="Allocate space for a chunk of the given size. ">qb_rb_chunk_alloc()</a> and then <a class="el" href="qbrb_8h.html#a0be62e0deea17d91292e2a84f6d864b9" title="finalize the chunk. ">qb_rb_chunk_commit()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
<tr><td class="paramname">data</td><td>(in) the data to write </td></tr>
<tr><td class="paramname">len</td><td>(in) the size of the chunk. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the amount of bytes actually buffered (either len or -1).</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#ae0e73503e8dc50e3cad1022bb740ef6c" title="Allocate space for a chunk of the given size. ">qb_rb_chunk_alloc()</a> </dd>
<dd>
<a class="el" href="qbrb_8h.html#a0be62e0deea17d91292e2a84f6d864b9" title="finalize the chunk. ">qb_rb_chunk_commit()</a> </dd></dl>
</div>
</div>
<a id="a961e46671f346f94fefa0690a12a9d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a961e46671f346f94fefa0690a12a9d71">◆ </a></span>qb_rb_chunks_used()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_chunks_used </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The total number of chunks in the buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a676646fa5f7d2dba585a92b99f91a84c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a676646fa5f7d2dba585a92b99f91a84c">◆ </a></span>qb_rb_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void qb_rb_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dereference the ringbuffer and if we are the last user destroy it. </p>
<p>All files, mmaped memory, semaphores and locks will be destroyed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aeaccf9973a435866fcddd937a2ad8f90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaccf9973a435866fcddd937a2ad8f90">◆ </a></span>qb_rb_create_from_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a>* qb_rb_create_from_file </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load the saved ring buffer from file into tempory memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>file with saved ringbuffer data. </td></tr>
<tr><td class="paramname">flags</td><td>same flags as passed into <a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31" title="Create the ring buffer with the given type. ">qb_rb_open()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>new ringbuffer instance </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#a53a05bc0ced76b97f38be38bfd4ee19f" title="Write the contents of the Ring Buffer to file. ">qb_rb_write_to_file()</a> </dd></dl>
</div>
</div>
<a id="aedda1312afff053ccbfddbd074351641"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedda1312afff053ccbfddbd074351641">◆ </a></span>qb_rb_name_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* qb_rb_name_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of the ringbuffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>name. </dd></dl>
</div>
</div>
<a id="ad7f0ee52204d491ddb6c5adf88e38c31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7f0ee52204d491ddb6c5adf88e38c31">◆ </a></span>qb_rb_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a>* qb_rb_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>shared_user_data_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the ring buffer with the given type. </p>
<p>This creates allocates a ring buffer in shared memory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the unique name of this ringbuffer. </td></tr>
<tr><td class="paramname">size</td><td>the requested size. </td></tr>
<tr><td class="paramname">flags</td><td>or'ed flags </td></tr>
<tr><td class="paramname">shared_user_data_size</td><td>size for a shared data area. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>the actual size will be rounded up to the next page size. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a new ring buffer or NULL if there was a problem. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#a3bf2613790c34f1da4da7e5d28b9f418" title="create a ring buffer (rather than open and existing one) ">QB_RB_FLAG_CREATE</a>, <a class="el" href="qbrb_8h.html#ac1857ecabb97a65d157bbc5ccaa536d9" title="New calls to qb_rb_chunk_write() will call qb_rb_chunk_reclaim() if there is not enough space...">QB_RB_FLAG_OVERWRITE</a>, <a class="el" href="qbrb_8h.html#afdb866bfc44855b73e4404f6526ce5ad" title="The ringbuffer will be shared between pthreads not processes. ">QB_RB_FLAG_SHARED_THREAD</a>, <a class="el" href="qbrb_8h.html#ac893c2640e8291e6229a227a861c760c" title="The ringbuffer will be shared between processes. ">QB_RB_FLAG_SHARED_PROCESS</a> </dd></dl>
</div>
</div>
<a id="abe1712513305a610df664f0b8a382d95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe1712513305a610df664f0b8a382d95">◆ </a></span>qb_rb_refcount_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t qb_rb_refcount_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the reference count. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of references </dd></dl>
</div>
</div>
<a id="aa18f8ca651e8ef29b43a311e280aee37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa18f8ca651e8ef29b43a311e280aee37">◆ </a></span>qb_rb_shared_user_data_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* qb_rb_shared_user_data_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a point to user shared data area. </p>
<dl class="section note"><dt>Note</dt><dd>this is of size "shared_user_data_size" passed into <a class="el" href="qbrb_8h.html#ad7f0ee52204d491ddb6c5adf88e38c31" title="Create the ring buffer with the given type. ">qb_rb_open()</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to shared data. </dd></dl>
</div>
</div>
<a id="a0e6b26f1c15cbd4050a9487e4399757c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e6b26f1c15cbd4050a9487e4399757c">◆ </a></span>qb_rb_space_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_space_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The amount of free space in the ring buffer. </p>
<dl class="section note"><dt>Note</dt><dd>Some of this space will be consumed by the chunk headers. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3aec2cca1b640d73c35efdcb545225f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aec2cca1b640d73c35efdcb545225f9">◆ </a></span>qb_rb_space_used()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_space_used </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The total amount of data in the buffer. </p>
<dl class="section note"><dt>Note</dt><dd>This includes the chunk headers (8 bytes per chunk). </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a53a05bc0ced76b97f38be38bfd4ee19f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53a05bc0ced76b97f38be38bfd4ee19f">◆ </a></span>qb_rb_write_to_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t qb_rb_write_to_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="qbrb_8h.html#aa73b885fa2fbda5dfe4f374e4e0ae0da">qb_ringbuffer_t</a> * </td>
<td class="paramname"><em>rb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>fd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the contents of the Ring Buffer to file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>open file to write the ringbuffer data to. </td></tr>
<tr><td class="paramname">rb</td><td>ringbuffer instance </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="qbrb_8h.html#aeaccf9973a435866fcddd937a2ad8f90" title="Load the saved ring buffer from file into tempory memory. ">qb_rb_create_from_file()</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|