iox2::EntryValueUninit< S, KeyType, ValueType > Class Template Reference

Wrapper around an uninitialized entry value that can be used for a zero-copy update. More...

#include <entry_value_uninit.hpp>

Public Member Functions
	EntryValueUninit (EntryValueUninit &&rhs) noexcept
auto	operator= (EntryValueUninit &&rhs) noexcept -> EntryValueUninit &
	~EntryValueUninit () noexcept
	EntryValueUninit (const EntryValueUninit &)=delete
auto	operator= (const EntryValueUninit &) -> EntryValueUninit &=delete
auto	value_mut () -> ValueType &

Friends
template<ServiceType , typename , typename >
class	EntryHandleMut
template<ServiceType ST, typename KeyT , typename ValueT >
auto	update_with_copy (EntryValueUninit< ST, KeyT, ValueT > &&self, ValueT value) -> EntryHandleMut< ST, KeyT, ValueT >
template<ServiceType ST, typename KeyT , typename ValueT >
auto	discard (EntryValueUninit< ST, KeyT, ValueT > &&self) -> EntryHandleMut< ST, KeyT, ValueT >
	Discard the [EntryValueUninit] and returns the original [EntryHandleMut].
template<ServiceType ST, typename KeyT , typename ValueT >
auto	assume_init_and_update (EntryValueUninit< ST, KeyT, ValueT > &&self) -> EntryHandleMut< ST, KeyT, ValueT >
template<ServiceType ST, typename KeyT , typename ValueT >
auto	loan_uninit (EntryHandleMut< ST, KeyT, ValueT > &&) -> EntryValueUninit< ST, KeyT, ValueT >

Detailed Description

template<ServiceType S, typename KeyType, typename ValueType>
class iox2::EntryValueUninit< S, KeyType, ValueType >

Wrapper around an uninitialized entry value that can be used for a zero-copy update.

Definition at line 27 of file entry_value_uninit.hpp.

Constructor & Destructor Documentation

EntryValueUninit() [1/2]

template<ServiceType S, typename KeyType , typename ValueType >

iox2::EntryValueUninit< S, KeyType, ValueType >::EntryValueUninit ( EntryValueUninit< S, KeyType, ValueType > &&  rhs )

inlinenoexcept

Definition at line 82 of file entry_value_uninit.hpp.

~EntryValueUninit()

template<ServiceType S, typename KeyType , typename ValueType >

iox2::EntryValueUninit< S, KeyType, ValueType >::~EntryValueUninit ( )

inlinenoexcept

Definition at line 105 of file entry_value_uninit.hpp.

EntryValueUninit() [2/2]

template<ServiceType S, typename KeyType , typename ValueType >

iox2::EntryValueUninit< S, KeyType, ValueType >::EntryValueUninit ( const EntryValueUninit< S, KeyType, ValueType > &  )

delete

Member Function Documentation

operator=() [1/2]

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryValueUninit< S, KeyType, ValueType >::operator= ( const EntryValueUninit< S, KeyType, ValueType > &  ) -> EntryValueUninit &=delete

delete

operator=() [2/2]

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryValueUninit< S, KeyType, ValueType >::operator= ( EntryValueUninit< S, KeyType, ValueType > &&  rhs ) -> EntryValueUninit&

inlinenoexcept

Definition at line 93 of file entry_value_uninit.hpp.

value_mut()

template<ServiceType S, typename KeyType , typename ValueType >

auto iox2::EntryValueUninit< S, KeyType, ValueType >::value_mut ( ) -> ValueType&

inline

Returns a reference to the value of the blackboard entry. It can be used to update the value without copy. After writing, assume_init_and_update() must be called.

Definition at line 132 of file entry_value_uninit.hpp.

Friends And Related Symbol Documentation

assume_init_and_update

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto assume_init_and_update ( EntryValueUninit< ST, KeyT, ValueT > &&  self ) -> EntryHandleMut< ST, KeyT, ValueT >

friend

Consumes the [EntryValueUninit], makes the new value accessible and returns the original [EntryHandleMut].

discard

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto discard ( EntryValueUninit< ST, KeyT, ValueT > &&  self ) -> EntryHandleMut< ST, KeyT, ValueT >

friend

Discard the [EntryValueUninit] and returns the original [EntryHandleMut].

EntryHandleMut

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType , typename , typename >

friend class EntryHandleMut

friend

Definition at line 57 of file entry_value_uninit.hpp.

loan_uninit

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto loan_uninit ( EntryHandleMut< ST, KeyT, ValueT > &&  ) -> EntryValueUninit< ST, KeyT, ValueT >

friend

update_with_copy

template<ServiceType S, typename KeyType , typename ValueType >

template<ServiceType ST, typename KeyT , typename ValueT >

auto update_with_copy ( EntryValueUninit< ST, KeyT, ValueT > &&  self, ValueT  value  ) -> EntryHandleMut< ST, KeyT, ValueT >

friend

Consumes the [EntryValueUninit], writes value to the entry value and returns the original [EntryHandleMut].

---

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

• iox2/entry_value_uninit.hpp