An unbounded lock-free multi-producer/multi-consumer queue. More...

#include <nikolaev_queue.hpp>

Public Member Functions
void	push (value_type value)
	Pushes the given value. More...

bool	try_pop (value_type &result)
	Tries to pop an element from the queue. More...

Detailed Description

template<class T, class... Policies>
class xenium::nikolaev_queue< T, Policies >

An unbounded lock-free multi-producer/multi-consumer queue.

This implementation is based on the unbounded MPMC queue proposed by Nikolaev [Nik19].

The nikoleav_queue provides lock-free progress guarantee under the condition that the number of threads concurrently operating on the queue is less than the capacity of a node (see entries_per_node policy).

Supported policies:

xenium::policy::reclaimer
Defines the reclamation scheme to be used for internal nodes. (required)
xenium::policy::entries_per_node
Defines the number of entries for each internal node. This must be a power of two. (optional; defaults to 512)
xenium::policy::pop_retries
Defines the number of iterations to spin on a queue entry while waiting for a pending push operation to finish. (optional; defaults to 1000) Note: this policy is applied to the internal queues. The Nikolaev queue internally uses two queues to manage the indexes of free/allocated slots. A push operation pops an item from the free queue, so this policy actually affects both, push and pop operations.

Template Parameters

T
Policies	list of policies to customize the behaviour

Member Function Documentation

◆ push()

template<class T , class... Policies>

void xenium::nikolaev_queue< T, Policies >::push ( value_type value )

Pushes the given value.

Progress guarantees: lock-free

Parameters

value

◆ try_pop()

template<class T , class... Policies>

bool xenium::nikolaev_queue< T, Policies >::try_pop ( value_type & result )

Tries to pop an element from the queue.