join::Mpsc< Type, Backend > Struct Template Reference

multiple producer single consumer ring buffer. More...

#include <queue.hpp>

Public Types
using	Queue = BasicQueue<Type, Backend, Mpsc>
using	Segment = QueueSegment<Type, QueueSlotFull<Type>>

Static Public Member Functions
static int	tryPush (Segment *segment, const Type &element, uint64_t &, uint64_t, uint64_t mask) noexcept
	try to push element into the ring buffer.
static ssize_t	tryPush (Segment *segment, const Type *elements, size_t size, uint64_t &, uint64_t capacity, uint64_t mask) noexcept
	try to push multiple elements into the ring buffer.
static int	tryPop (Segment *segment, Type &element, uint64_t &, uint64_t capacity, uint64_t mask) noexcept
	try to pop element from the ring buffer.
static ssize_t	tryPop (Segment *segment, Type *elements, size_t size, uint64_t &, uint64_t capacity, uint64_t mask) noexcept
	try to pop multiple elements from the ring buffer.

Detailed Description

template<typename Type, typename Backend>
struct join::Mpsc< Type, Backend >

multiple producer single consumer ring buffer.

Member Typedef Documentation

Queue

template<typename Type , typename Backend >

using join::Mpsc< Type, Backend >::Queue = BasicQueue<Type, Backend, Mpsc>

Segment

template<typename Type , typename Backend >

using join::Mpsc< Type, Backend >::Segment = QueueSegment<Type, QueueSlotFull<Type>>

Member Function Documentation

tryPop() [1/2]

template<typename Type , typename Backend >

static int join::Mpsc< Type, Backend >::tryPop ( Segment * segment, Type & element, uint64_t & , uint64_t capacity, uint64_t mask )

inlinestaticnoexcept

try to pop element from the ring buffer.

Parameters

segment	shared memory segment.
element	output element.
cachedHead	consumer-side cached index (not used).
capacity	memory segment capacity.
mask	bit mask for fast modulo.

Returns

0 on success, -1 otherwise.

tryPop() [2/2]

template<typename Type , typename Backend >

static ssize_t join::Mpsc< Type, Backend >::tryPop ( Segment * segment, Type * elements, size_t size, uint64_t & , uint64_t capacity, uint64_t mask )

inlinestaticnoexcept

try to pop multiple elements from the ring buffer.

Parameters

segment	shared memory segment.
elements	pointer to the output buffer.
size	maximum number of elements to pop.
cachedHead	consumer-side cached index (not used).
capacity	memory segment capacity.
mask	bit mask for fast modulo.

Returns

number of elements successfully popped, -1 otherwise.

tryPush() [1/2]

template<typename Type , typename Backend >

static int join::Mpsc< Type, Backend >::tryPush ( Segment * segment, const Type & element, uint64_t & , uint64_t , uint64_t mask )

inlinestaticnoexcept

try to push element into the ring buffer.

Parameters

segment	shared memory segment.
element	element to push.
cachedTail	producer-side cached index (not used).
capacity	memory segment capacity (not used).
mask	bit mask for fast modulo.

Returns

0 on success, -1 otherwise.

tryPush() [2/2]

template<typename Type , typename Backend >

static ssize_t join::Mpsc< Type, Backend >::tryPush ( Segment * segment, const Type * elements, size_t size, uint64_t & , uint64_t capacity, uint64_t mask )

inlinestaticnoexcept

try to push multiple elements into the ring buffer.

Parameters

segment	shared memory segment.
elements	pointer to the first element.
size	number of elements to push.
cachedTail	producer-side cached index (not used).
capacity	memory segment capacity.
mask	bit mask for fast modulo.

Returns

number of elements successfully pushed, -1 otherwise.

---

The documentation for this struct was generated from the following files:

• core/include/join/memory.hpp
• core/include/join/queue.hpp