sim_interface::SharedQueue< T > Class Template Reference

A thread save shared queue to communicate between multiple threads. The queue is a FIFO queue. More...

#include <SharedQueue.h>

Public Member Functions
	SharedQueue ()=default
	SharedQueue (const SharedQueue< T > &)=delete
void	push (T elem)
bool	pop (T &elem)
void	Stop ()
virtual	~SharedQueue ()

Detailed Description

template<class T>
class sim_interface::SharedQueue< T >

A thread save shared queue to communicate between multiple threads. The queue is a FIFO queue.

Constructor & Destructor Documentation

SharedQueue() [1/2]

template<class T >

sim_interface::SharedQueue< T >::SharedQueue ( )

default

Create a shared queue.

SharedQueue() [2/2]

template<class T >

sim_interface::SharedQueue< T >::SharedQueue ( const SharedQueue< T > &  )

delete

Destroys the queue.

~SharedQueue()

template<class T >

virtual sim_interface::SharedQueue< T >::~SharedQueue ( )

inlinevirtual

Destroys and stops the queue.

Member Function Documentation

pop()

template<class T >

bool sim_interface::SharedQueue< T >::pop ( T &  elem )

inline

Get the first element in the queue.

Parameters

elem	Reverence to the first element.

Returns

Returns TRUE if the element is valid and FALSE if not.

push()

template<class T >

void sim_interface::SharedQueue< T >::push ( T  elem )

inline

Push a element at the end of the queue.

Parameters

elem	Element to add to the queue.

Stop()

template<class T >

void sim_interface::SharedQueue< T >::Stop ( )

inline

Stops the queue and enqueues all its elements.

---

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

• Sim_To_DuT_Interface/Utility/SharedQueue.h