Devel::Threading::CSafeQueue< T > Class Template Reference

Public Member Functions
const CMutex &	mutex () const
	Returns a const reference to the mutex associated with the safe queue. More...
size_t	size () const
	Returns the number of elements in the safe queue. More...
bool	isEmpty () const
	Checks if the safe queue is empty. More...
void	enqueue (const T &i_tValue)
	Enqueues an element into the safe queue. More...
void	enqueue (T &&i_tValue)
	Enqueues an rvalue reference to an element into the safe queue. More...
T	dequeue (const bool i_fMove=true)
	Dequeues and returns an element from the safe queue. More...
T	front (const bool i_fMove=false)
	Returns a reference to the front element of the safe queue without removing it. More...
void	pop ()
	Removes the front element from the safe queue.
void	clear ()
	Removes all elements from the safe queue.

Member Function Documentation

dequeue()

template<class T >

T Devel::Threading::CSafeQueue< T >::dequeue ( const bool  i_fMove = true )

inline

Dequeues and returns an element from the safe queue.

Parameters

i_fMove

If true, the returned element is moved, otherwise a copy is made.

Returns

The dequeued element.

enqueue() [1/2]

template<class T >

void Devel::Threading::CSafeQueue< T >::enqueue ( const T &  i_tValue )

inline

Enqueues an element into the safe queue.

Parameters

i_tValue

The element to enqueue.

enqueue() [2/2]

template<class T >

void Devel::Threading::CSafeQueue< T >::enqueue ( T &&  i_tValue )

inline

Enqueues an rvalue reference to an element into the safe queue.

Parameters

i_tValue

The rvalue reference to an element to enqueue.

front()

template<class T >

T Devel::Threading::CSafeQueue< T >::front ( const bool  i_fMove = false )

inline

Returns a reference to the front element of the safe queue without removing it.

Parameters

i_fMove

If true, the front element is moved, otherwise a copy is made.

Returns

The reference to the front element.

isEmpty()

template<class T >

bool Devel::Threading::CSafeQueue< T >::isEmpty ( ) const

inline

Checks if the safe queue is empty.

Returns

True if the safe queue is empty, false otherwise.

mutex()

template<class T >

const CMutex& Devel::Threading::CSafeQueue< T >::mutex ( ) const

inline

Returns a const reference to the mutex associated with the safe queue.

Returns

The mutex object.

size()

template<class T >

size_t Devel::Threading::CSafeQueue< T >::size ( ) const

inline

Returns the number of elements in the safe queue.

Returns

The number of elements.

---

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

• /home/runner/work/devel-library/devel-library/Threading/SafeQueue/SafeQueue.h