qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer > Class Template Reference

Multi-Producer Single-Consumer ring buffer with fixed number of producers. More...

#include <mpsc.h>

Inheritance diagram for qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >:

Collaboration diagram for qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >:

Public Member Functions
template<size_t _Index>
bool	enqueue (T const &t)
	Enqueue an item using a compile-time producer index.
template<size_t _Index, bool _All = true>
size_t	enqueue (T const *t, size_t const size)
	Enqueue multiple items using a compile-time producer index.
bool	enqueue (size_t const index, T const &t)
	Enqueue an item using a runtime producer index.
template<bool _All = true>
size_t	enqueue (size_t const index, T const *t, size_t const size)
	Enqueue multiple items using a runtime producer index.
size_t	enqueue (T const &t)
	Enqueue an item using a random producer index.
template<bool _All = true>
size_t	enqueue (T const *t, size_t const size)
	Enqueue multiple items using a random producer index.
size_t	dequeue (T *ret, size_t size)
	Dequeue multiple items from all producers.
template<typename Func>
size_t	dequeue (Func const &func, T *ret, size_t const size)
	Dequeue multiple items with a function to process each item.
template<typename Func>
size_t	consume_all (Func const &func)
	Process all available items from all producers.
auto &	ringOf (size_t const index)
	Get direct access to a specific producer's ring buffer.
Public Member Functions inherited from qb::nocopy
	nocopy ()=default
	Default constructor.
	nocopy (nocopy const &)=delete
	Deleted copy constructor.
	nocopy (nocopy const &&)=delete
	Deleted move constructor.
nocopy &	operator= (nocopy const &)=delete
	Deleted copy assignment operator.
nocopy &	operator= (nocopy &&)=delete
	Deleted move assignment operator.

Detailed Description

template<typename T, std::size_t max_size, size_t nb_producer = 0>
class qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >

Multi-Producer Single-Consumer ring buffer with fixed number of producers.

This implementation provides a lock-free MPSC ring buffer with a compile-time fixed number of producers. Each producer has its own dedicated SPSC ring buffer, eliminating contention between producers.

Template Parameters

T	The type of elements stored in the buffer
max_size	The maximum capacity per producer buffer
nb_producer	The number of producers (fixed at compile time)

Member Function Documentation

enqueue() [1/6]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

template<size_t _Index>

bool qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::enqueue ( T const & t )

inline

Enqueue an item using a compile-time producer index.

Template Parameters

_Index

The compile-time index of the producer

Parameters

t	The item to enqueue

Returns

true if the item was successfully enqueued, false if the buffer was full

enqueue() [2/6]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

template<size_t _Index, bool _All = true>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::enqueue ( T const * t, size_t const size )

inline

Enqueue multiple items using a compile-time producer index.

Template Parameters

_Index	The compile-time index of the producer
_All	If true, requires all items to be enqueued or none

Parameters

t	Array of items to enqueue
size	Number of items to enqueue

Returns

The number of items successfully enqueued

enqueue() [3/6]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

bool qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::enqueue ( size_t const index, T const & t )

inline

Enqueue an item using a runtime producer index.

Parameters

index	The runtime index of the producer
t	The item to enqueue

Returns

true if the item was successfully enqueued, false if the buffer was full

enqueue() [4/6]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

template<bool _All = true>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::enqueue ( size_t const index, T const * t, size_t const size )

inline

Enqueue multiple items using a runtime producer index.

Template Parameters

_All	If true, requires all items to be enqueued or none

Parameters

index	The runtime index of the producer
t	Array of items to enqueue
size	Number of items to enqueue

Returns

The number of items successfully enqueued

enqueue() [5/6]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::enqueue ( T const & t )

inline

Enqueue an item using a random producer index.

This method automatically selects a producer based on the current time, providing load balancing across producers.

Parameters

t	The item to enqueue

Returns

true if the item was successfully enqueued, false if the buffer was full

enqueue() [6/6]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

template<bool _All = true>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::enqueue ( T const * t, size_t const size )

inline

Enqueue multiple items using a random producer index.

This method automatically selects a producer based on the current time, providing load balancing across producers.

Template Parameters

_All	If true, requires all items to be enqueued or none

Parameters

t	Array of items to enqueue
size	Number of items to enqueue

Returns

The number of items successfully enqueued

dequeue() [1/2]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::dequeue ( T * ret, size_t size )

inline

Dequeue multiple items from all producers.

This method tries to dequeue items from all producers' buffers until either the requested number of items is dequeued or all buffers are empty.

Parameters

ret	Array to store the dequeued items
size	Maximum number of items to dequeue

Returns

The number of items successfully dequeued

dequeue() [2/2]

template<typename T, std::size_t max_size, size_t nb_producer = 0>

template<typename Func>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::dequeue ( Func const & func, T * ret, size_t const size )

inline

Dequeue multiple items with a function to process each item.

Template Parameters

Func	Type of the function to process dequeued items

Parameters

func	Function to process each dequeued item
ret	Array to store the dequeued items
size	Maximum number of items to dequeue

Returns

The number of items successfully dequeued and processed

consume_all()

template<typename T, std::size_t max_size, size_t nb_producer = 0>

template<typename Func>

size_t qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::consume_all ( Func const & func )

inline

Process all available items from all producers.

Template Parameters

Func	Type of the function to process dequeued items

Parameters

func	Function to process each dequeued item

Returns

The number of items successfully processed

ringOf()

template<typename T, std::size_t max_size, size_t nb_producer = 0>

auto & qb::lockfree::mpsc::ringbuffer< T, max_size, nb_producer >::ringOf ( size_t const index )

inline

Get direct access to a specific producer's ring buffer.

Parameters

index

The index of the producer

Returns

Reference to the producer's ring buffer