Diligent::MPSCQueue< T > Class Template Reference

#include <MPSCQueue.hpp>

Public Member Functions
	MPSCQueue ()
	Constructs an empty MPSCQueue.
	~MPSCQueue ()
void	Enqueue (T value)
bool	Dequeue (T &result)
bool	IsEmpty () const
	Checks if the queue is empty.

Detailed Description

template<typename T>
class Diligent::MPSCQueue< T >

Multi-Producer Single-Consumer (MPSC) queue.

The queue enables multiple producers to enqueue items concurrently, while a single consumer can dequeue items. Dequeue operations are lock-free.

Template Parameters

T	The type of items stored in the queue. Must be default-constructible, move-constructible, and move-assignable.

Constructor & Destructor Documentation

~MPSCQueue()

template<typename T>

Diligent::MPSCQueue< T >::~MPSCQueue ( )

inline

Destructs the MPSCQueue and releases all resources.

Warning

Not thread-safe. All producers must be stopped/joined before destruction.

Member Function Documentation

Dequeue()

template<typename T>

bool Diligent::MPSCQueue< T >::Dequeue ( T & result )

inline

Dequeues a value from the queue. The method is thread-safe and can be called in parallel with producers, but only one consumer should call it.

Parameters

result

A reference to store the dequeued value. It will be moved from the queue.

Returns

true if a value was successfully dequeued; false if the queue was empty.

Enqueue()

template<typename T>

void Diligent::MPSCQueue< T >::Enqueue ( T value )

inline

Enqueues a value into the queue. The method is thread-safe and can be called concurrently by multiple producers.

Parameters

value

The value to enqueue. It will be moved into the queue.