ros2_canopen::SafeQueue< T > Class Template Reference

Thread Safe Queue for CANOpen Data Exchange. More...

#include <exchange.hpp>

Public Member Functions
	SafeQueue (std::size_t capacity=10)
	Constructor for the SafeQueue. More...
void	push (T value)
	Push a value to the queue. More...
std::optional< T >	try_pop ()
	Try to pop a value from the queue. More...
bool	try_pop (T &value)
	Try to pop a value from the queue. More...
boost::optional< T >	wait_and_pop ()
	Wait for a value to be available in the queue. More...
void	wait_and_pop (T &value)
	Wait for a value to be available in the queue for a given timeout. More...
boost::optional< T >	wait_and_pop_for (const std::chrono::milliseconds &timeout)
	Wait for a value to be available in the queue for a given timeout. More...
bool	wait_and_pop_for (const std::chrono::milliseconds &timeout, T &value)
	Wait for a value to be available in the queue for a given timeout. More...
bool	empty () const

Detailed Description

template<typename T>
class ros2_canopen::SafeQueue< T >

Thread Safe Queue for CANOpen Data Exchange.

Template Parameters

T	Type of the data to be exchanged

This class is a wrapper around boost::lockfree::queue to provide thread safe data exchange between threads using the queue.

Constructor & Destructor Documentation

SafeQueue()

template<typename T >

ros2_canopen::SafeQueue< T >::SafeQueue ( std::size_t  capacity = 10 )

inlineexplicit

Constructor for the SafeQueue.

Parameters

capacity

Capacity of the queue

Member Function Documentation

push()

template<typename T >

void ros2_canopen::SafeQueue< T >::push ( T  value )

inline

Push a value to the queue.

Parameters

value

Value to be pushed

try_pop() [1/2]

template<typename T >

std::optional<T> ros2_canopen::SafeQueue< T >::try_pop ( )

inline

Try to pop a value from the queue.

Returns

Value if available, boost::none otherwise

try_pop() [2/2]

template<typename T >

bool ros2_canopen::SafeQueue< T >::try_pop ( T &  value )

inline

Try to pop a value from the queue.

Parameters

value

Value to be returned

wait_and_pop() [1/2]

template<typename T >

boost::optional<T> ros2_canopen::SafeQueue< T >::wait_and_pop ( )

inline

Wait for a value to be available in the queue.

Returns

Value if available, boost::none otherwise

wait_and_pop() [2/2]

template<typename T >

void ros2_canopen::SafeQueue< T >::wait_and_pop ( T &  value )

inline

Wait for a value to be available in the queue for a given timeout.

Parameters

value

Value to be returned

wait_and_pop_for() [1/2]

template<typename T >

boost::optional<T> ros2_canopen::SafeQueue< T >::wait_and_pop_for ( const std::chrono::milliseconds &  timeout )

inline

Wait for a value to be available in the queue for a given timeout.

Parameters

timeout

Timeout in milliseconds

Returns

Value if available, boost::none otherwise

wait_and_pop_for() [2/2]

template<typename T >

bool ros2_canopen::SafeQueue< T >::wait_and_pop_for ( const std::chrono::milliseconds &  timeout, T &  value  )

inline

Wait for a value to be available in the queue for a given timeout.

Parameters

timeout	Timeout in milliseconds
value	Value to be returned

empty()

template<typename T >

bool ros2_canopen::SafeQueue< T >::empty ( ) const

inline

---

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

• /home/runner/work/ros2_canopen/ros2_canopen/canopen_core/include/canopen_core/exchange.hpp