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>

Static Public Member Functions
static int	tryPush (QueueSegment< Type > *segment, const Type &element) noexcept
	try to push element into the ring buffer.
static int	tryPop (QueueSegment< Type > *segment, Type &element) noexcept
	try to pop element 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>

Member Function Documentation

tryPop()

template<typename Type , typename Backend >

static int join::Mpsc< Type, Backend >::tryPop ( QueueSegment< Type > * 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.

tryPush()

template<typename Type , typename Backend >

static int join::Mpsc< Type, Backend >::tryPush ( QueueSegment< Type > * 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.

---

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

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