summaryrefslogtreecommitdiffstats
path: root/src/fluent-bit/lib/lwrb/docs/tips-tricks/index.rst
blob: feb81ce4bbda2d2fbdfbc2b5422267cde38be070 (plain)
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
.. _tips_tricks:

Tips & tricks
=============

Application buffer size
^^^^^^^^^^^^^^^^^^^^^^^

Buffer size shall always be ``1`` byte bigger than anticipated data size.

When application uses buffer for some data block ``N`` times, it is advised to set buffer size to ``1`` byte more than ``N * block_size`` is.
This is due to ``R`` and ``W`` pointers alignment.

.. note:: 
    For more information, check :ref:`how_it_works`.

.. literalinclude:: ../examples_src/example_tt_buff_size.c
    :language: c
    :linenos:
    :caption: Application buffer size assignment

When the code is executed, it produces following output:

.. literalinclude:: ../examples_src/example_tt_buff_size_log.c
    :caption: Application buffer size assignment output

.. toctree::
    :maxdepth: 2