4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
3.6 KiB
| title |
|---|
| bip_buffer_spsc_atomic |
{{< callout >}}
Header: bip_buffer_spsc_atomic.h
Since: tbc
{{< /callout >}}
A fixed capacity bipartite buffer.
A bipartite buffer is a memory buffer design that uses two contiguous halves of the same underlying memory block to create a seamless, wraparound-free view of a circular/ring buffer's contents.
The Problem It Solves
Ring buffers are efficient for streaming data, but when data wraps around the end of the buffer back to the beginning, reading a contiguous chunk across that boundary normally requires two separate reads or a temporary copy.
How It Works
A bipartite buffer allocates a backing array that is twice the needed capacity. The two halves (the "bipartite" part) are mapped to the same physical memory, so:
The first region covers indices 0 to N-1 The second region covers indices N to 2N-1, but maps to the same memory as the first
This means any contiguous slice of up to N bytes can always be read as a single, linear pointer — no wraparound, no copying, no splitting.
etl::bip_buffer_spsc_atomic<typename T,
size_t SIZE,
size_t MEMORY_MODEL = etl::memory_model::MEMORY_MODEL_LARGE>
Inherits from etl::ibip_buffer_spsc_atomic<T>.
etl::ibip_buffer_spsc_atomic may be used as a size independent pointer or reference type for any etl::bip_buffer_spsc_atomic instance.
Member types
value_type
size_type
reference
const_reference
rvalue_reference
Static Constants
MAX_SIZE The maximum size of the circular_buffer.
Constructor
etl::bip_buffer_spsc_atomic<typename T,
size_t SIZE,
size_t MEMORY_MODEL = etl::memory_model::MEMORY_MODEL_LARGE>();
Capacity
bool empty() const
Description
Returns true if the size of the circular buffer is zero, otherwise false.
bool full() const
Description
Returns true if the size of the circular buffer is SIZE, otherwise false.
size_t size() const
Description
Returns the size of the circular buffer.
size_t max_size() const
Description
Returns the maximum possible size of the circular buffer.
size_t capacity() const
Description
Returns the maximum possible size of the circular buffer.
size_t available() const
Description
Returns the remaining available capacity in the circular buffer.
Modifiers
etl::span<T> read_reserve(size_type max_reserve_size = numeric_limits<size_type>::max())
Description
Reserves a memory area for reading (up to the max_reserve_size).
void read_commit(const etl::span<T> &reserve)
Description
Commits the previously reserved read memory area
the reserve can be trimmed at the end before committing.
Throws bip_buffer_reserve_invalid.
etl::span<T> write_reserve(size_type max_reserve_size)
Description
Reserves a memory area for writing up to the max_reserve_size.
etl::span<T> write_reserve_optimal(size_type min_reserve_size = 1U)
Description
Reserves an optimal memory area for writing. The buffer will only wrap
around if the available forward space is less than min_reserve_size.
void write_commit(const etl::span<T> &reserve)
Description
Commits the previously reserved write memory area
the reserve can be trimmed at the end before committing.
Throws bip_buffer_reserve_invalid
void clear()
Description
Clears the buffer, destructing any elements that haven't been read.