AZStd::lock_free_queue< T, Allocator > Class Template Reference

#include <lock_free_queue.h>

Public Types
typedef T *	pointer
typedef const T *	const_pointer
typedef T &	reference
typedef const T &	const_reference
typedef Allocator::difference_type	difference_type
typedef Allocator::size_type	size_type
typedef Allocator	allocator_type
typedef T	value_type
typedef Internal::lock_free_queue_node< T >	node_type
typedef node_type *	node_ptr_type

Public Member Functions
void	push (const_reference value)
	Pushes a value onto the back of the queue.
bool	pop (pointer value_out)
bool	empty () const
	Tests if the queue is empty, limited utility for a concurrent container.

Detailed Description

template<typename T, typename Allocator>
class AZStd::lock_free_queue< T, Allocator >

A lock-free queue implementation. Requires an allocator, which must also be lock-free, allow stale reads, and not recycle allocations concurrently (to avoid the ABA problem).

Member Function Documentation

pop()

template<typename T , typename Allocator >

bool AZStd::lock_free_queue< T, Allocator >::pop ( pointer  value_out )

inline

Attempts to pop a value from the front of the queue. Returns false if the queue was empty, otherwise popped value is stored in value_out and returns true.

---

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

• Code/Framework/AzCore/AzCore/std/parallel/containers/lock_free_queue.h