realtime_tools::RealtimeBoxBase< T, mutex_type > Class Template Reference

#include <realtime_box.hpp>

Public Types
using	mutex_t = mutex_type
using	type = T

Public Member Functions
constexpr	RealtimeBoxBase (const T &init=T{})
constexpr	RealtimeBoxBase (const T &&init)
constexpr	RealtimeBoxBase (const RealtimeBoxBase &o)
constexpr RealtimeBoxBase &	operator= (const RealtimeBoxBase &o)
constexpr	RealtimeBoxBase (RealtimeBoxBase &&o)
template<typename U = T>
constexpr	RealtimeBoxBase (const std::initializer_list< U > &init, std::enable_if_t< std::is_constructible_v< U, std::initializer_list< U > > >)
constexpr RealtimeBoxBase &	operator= (RealtimeBoxBase &&o)
template<typename U = T>
std::enable_if_t<!is_ptr_or_smart_ptr< U >, bool >	try_set (const T &value)
	set a new content with best effort
bool	try_set (const std::function< void(T &)> &func)
	access the content readable with best effort
template<typename U = T>
std::enable_if_t<!is_ptr_or_smart_ptr< U >, std::optional< U > >	try_get () const
	get the content with best effort
bool	try_get (const std::function< void(const T &)> &func)
	access the content (r) with best effort
template<typename U = T>
std::enable_if_t<!is_ptr_or_smart_ptr< U >, void >	set (const T &value)
	Wait until the mutex can be locked and set the content (RealtimeBox behavior)
void	set (const std::function< void(T &)> &func)
	wait until the mutex could be locked and access the content (rw)
template<typename U = T>
std::enable_if_t<!is_ptr_or_smart_ptr< U >, U >	get () const
	Wait until the mutex could be locked and get the content (RealtimeBox behaviour)
template<typename U = T>
std::enable_if_t<!is_ptr_or_smart_ptr< U >, void >	get (T &in) const
	Wait until the mutex could be locked and get the content (r)
void	get (const std::function< void(const T &)> &func)
	Wait until the mutex could be locked and access the content (r)
template<typename U = T>
std::enable_if_t<!is_ptr_or_smart_ptr< U >, void >	operator= (const T &value)
	provide a custom assignment operator for easier usage
template<typename U = T, typename = typename std::enable_if_t<!is_ptr_or_smart_ptr<U>>>
	operator T () const
	provide a custom conversion operator
template<typename U = T, typename = typename std::enable_if_t<!is_ptr_or_smart_ptr<U>>>
	operator std::optional< T > () const
	provide a custom conversion operator
const mutex_t &	get_mutex () const
mutex_t &	get_mutex ()

Detailed Description

template<class T, typename mutex_type = std::mutex>
class realtime_tools::RealtimeBoxBase< T, mutex_type >

A Box that ensures thread safe access to the boxed contents. Access is best effort. If it can not lock it will return.

NOTE about pointers: You can use pointers with this box but the access will be different. Only use the get/set methods that take function pointer for accessing the internal value.

Member Function Documentation

get() [1/3]

template<class T , typename mutex_type = std::mutex>

template<typename U = T>

std::enable_if_t<!is_ptr_or_smart_ptr< U >, U > realtime_tools::RealtimeBoxBase< T, mutex_type >::get ( ) const

inline

Wait until the mutex could be locked and get the content (RealtimeBox behaviour)

Returns

copy of the value

get() [2/3]

template<class T , typename mutex_type = std::mutex>

void realtime_tools::RealtimeBoxBase< T, mutex_type >::get ( const std::function< void(const T &)> &  func )

inline

Wait until the mutex could be locked and access the content (r)

Note

only safe way to access pointer type content (r)

same signature as in the existing RealtimeBox<T>

get() [3/3]

template<class T , typename mutex_type = std::mutex>

template<typename U = T>

std::enable_if_t<!is_ptr_or_smart_ptr< U >, void > realtime_tools::RealtimeBoxBase< T, mutex_type >::get ( T &  in ) const

inline

Wait until the mutex could be locked and get the content (r)

Note

same signature as in the existing RealtimeBox<T>

operator std::optional< T >()

template<class T , typename mutex_type = std::mutex>

template<typename U = T, typename = typename std::enable_if_t<!is_ptr_or_smart_ptr<U>>>

realtime_tools::RealtimeBoxBase< T, mutex_type >::operator std::optional< T > ( ) const

inline

provide a custom conversion operator

Note

Can be used from non-RT and RT contexts

operator T()

template<class T , typename mutex_type = std::mutex>

template<typename U = T, typename = typename std::enable_if_t<!is_ptr_or_smart_ptr<U>>>

realtime_tools::RealtimeBoxBase< T, mutex_type >::operator T ( ) const

inline

provide a custom conversion operator

Note

Can only be used from non-RT!

operator=()

template<class T , typename mutex_type = std::mutex>

template<typename U = T>

std::enable_if_t<!is_ptr_or_smart_ptr< U >, void > realtime_tools::RealtimeBoxBase< T, mutex_type >::operator= ( const T &  value )

inline

provide a custom assignment operator for easier usage

Note

only to be used from non-RT!

set()

template<class T , typename mutex_type = std::mutex>

template<typename U = T>

std::enable_if_t<!is_ptr_or_smart_ptr< U >, void > realtime_tools::RealtimeBoxBase< T, mutex_type >::set ( const T &  value )

inline

Wait until the mutex can be locked and set the content (RealtimeBox behavior)

Note

disabled for pointer types

same signature as in the existing RealtimeBox<T>

try_get() [1/2]

template<class T , typename mutex_type = std::mutex>

template<typename U = T>

std::enable_if_t<!is_ptr_or_smart_ptr< U >, std::optional< U > > realtime_tools::RealtimeBoxBase< T, mutex_type >::try_get ( ) const

inline

get the content with best effort

Returns

std::nullopt if content could not be access, otherwise the content is returned

try_get() [2/2]

template<class T , typename mutex_type = std::mutex>

bool realtime_tools::RealtimeBoxBase< T, mutex_type >::try_get ( const std::function< void(const T &)> &  func )

inline

access the content (r) with best effort

Returns

false if the mutex could not be locked

Note

only safe way to access pointer type content (r)

try_set() [1/2]

template<class T , typename mutex_type = std::mutex>

bool realtime_tools::RealtimeBoxBase< T, mutex_type >::try_set ( const std::function< void(T &)> &  func )

inline

access the content readable with best effort

Returns

false if the mutex could not be locked

Note

only safe way to access pointer type content (rw)

try_set() [2/2]

template<class T , typename mutex_type = std::mutex>

template<typename U = T>

std::enable_if_t<!is_ptr_or_smart_ptr< U >, bool > realtime_tools::RealtimeBoxBase< T, mutex_type >::try_set ( const T &  value )

inline

set a new content with best effort

Returns

false if mutex could not be locked

Note

disabled for pointer types

---

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

• realtime_tools/realtime_tools/include/realtime_tools/realtime_box.hpp