Foundation::Core::AtomicStack< T > Class Template Reference

Atomic, unbounded LIFO stack with lock-free push and pop operations. More...

#include <AtomicStack.hpp>

Classes
struct	Node
struct	PTag

Public Member Functions
	AtomicStack (Allocator *alloc)
	Construct the Stack.
template<typename U >
void	Push (U &&value)
	Push a value onto the stack.
bool	Pop (T &out)
	Pop a value from the stack.
	~AtomicStack ()

Private Attributes
Atomic< PTag >	mTop {}
Allocator *	mAlloc

Detailed Description

template<typename T>
class Foundation::Core::AtomicStack< T >

Atomic, unbounded LIFO stack with lock-free push and pop operations.

Note

Memory allocations are performed on each push and deallocations on each pop. This also requires a thread-safe Allocator, which Core provides.

Consider using AtomicPool for fixed-size allocations to reduce allocation overhead if a max-bound is known.

Template Parameters

T	Data type, must be default constructible.

Constructor & Destructor Documentation

AtomicStack()

template<typename T >

Foundation::Core::AtomicStack< T >::AtomicStack ( Allocator *  alloc )

inline

Construct the Stack.

Parameters

alloc

Allocator to use for element allocations.

~AtomicStack()

template<typename T >

Foundation::Core::AtomicStack< T >::~AtomicStack ( )

inline

Member Function Documentation

Pop()

template<typename T >

bool Foundation::Core::AtomicStack< T >::Pop ( T &  out )

inline

Pop a value from the stack.

Parameters

out	Reference to receive the popped value. This is only valid if the function returns true.

Note

Multiple threads may call this concurrently.

Returns

True if a value was popped, false if the stack was empty.

Push()

template<typename T >

template<typename U >

void Foundation::Core::AtomicStack< T >::Push ( U &&  value )

inline

Push a value onto the stack.

Note

Multiple threads may call this concurrently.

Template Parameters

U	Type of the value to push. May be different from T, but must be convertible to T.

Parameters

value

The value to push. This is forwarded to T's constructor.

Member Data Documentation

mAlloc

template<typename T >

Allocator* Foundation::Core::AtomicStack< T >::mAlloc

private

mTop

template<typename T >

Atomic<PTag> Foundation::Core::AtomicStack< T >::mTop {}

private

---

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

• Source/Core/AtomicStack.hpp