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

single producer single consumer ring buffer. More...

#include <queue.hpp>

Public Types
using	Queue = BasicQueue<Type, Backend, Spsc>
using	Segment = QueueSegment<Type, QueueSlotLight<Type>>

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

Detailed Description

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

single producer single consumer ring buffer.

Member Typedef Documentation

Queue

template<typename Type , typename Backend >

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

Segment

template<typename Type , typename Backend >

using join::Spsc< Type, Backend >::Segment = QueueSegment<Type, QueueSlotLight<Type>>

Member Function Documentation

tryPop() [1/2]

template<typename Type , typename Backend >

static int join::Spsc< Type, Backend >::tryPop ( Segment * segment, Type & element )

inlinestaticnoexcept

try to pop element from the ring buffer.

Parameters

segment	shared memory segment.
element	output element.

Returns

0 on success, -1 otherwise.

tryPop() [2/2]

template<typename Type , typename Backend >

static ssize_t join::Spsc< Type, Backend >::tryPop ( Segment * segment, Type * elements, size_t size )

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.

Returns

number of elements successfully popped, -1 otherwise.

tryPush() [1/2]

template<typename Type , typename Backend >

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

inlinestaticnoexcept

try to push element into the ring buffer.

Parameters

segment	shared memory segment.
element	element to push.

Returns

0 on success, -1 otherwise.

tryPush() [2/2]

template<typename Type , typename Backend >

static ssize_t join::Spsc< Type, Backend >::tryPush ( Segment * segment, const Type * elements, size_t size )

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.

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