TClosableMpscQueue< T > Class Template Reference

#include <ClosableMpscQueue.h>

Public Member Functions
	UE_NONCOPYABLE (TClosableMpscQueue)
	TClosableMpscQueue ()=default
	~TClosableMpscQueue ()
template<typename... ArgTypes>
bool	Enqueue (ArgTypes &&... Args)
template<typename F >
bool	Close (const F &Consumer)
bool	IsClosed () const

Detailed Description

template<typename T>
class TClosableMpscQueue< T >

Multi-producer/single-consumer unbounded concurrent queue that can be consumed only once.

Constructor & Destructor Documentation

TClosableMpscQueue()

template<typename T >

TClosableMpscQueue< T >::TClosableMpscQueue ( )

default

~TClosableMpscQueue()

template<typename T >

TClosableMpscQueue< T >::~TClosableMpscQueue ( )

inline

Member Function Documentation

Close()

template<typename T >

template<typename F >

bool TClosableMpscQueue< T >::Close ( const F &  Consumer )

inline

Closes the queue and consumes all items.

Parameters

Consumer

a functor with signature AnyReturnType (T Value) that will receive all items in FIFO order

Returns

false if already closed

Enqueue()

template<typename T >

template<typename... ArgTypes>

bool TClosableMpscQueue< T >::Enqueue ( ArgTypes &&...  Args )

inline

Returns false if the queue is closed

IsClosed()

template<typename T >

bool TClosableMpscQueue< T >::IsClosed ( ) const

inline

UE_NONCOPYABLE()

template<typename T >

TClosableMpscQueue< T >::UE_NONCOPYABLE

(

TClosableMpscQueue< T >

)

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/Containers/ClosableMpscQueue.h