iox2::Reader< S, KeyType > Class Template Reference

Reading endpoint of a blackboard based communication. More...

#include <reader.hpp>

Public Member Functions
	Reader (Reader &&rhs) noexcept
auto	operator= (Reader &&rhs) noexcept -> Reader &
	~Reader ()
	Reader (const Reader &)=delete
auto	operator= (const Reader &) -> Reader &=delete
auto	id () const -> UniqueReaderId
	Returns the [UniqueReaderId] of the [Reader].
auto	name () const -> PortNameView
	Returns the [PortNameView] of the [Reader].
template<typename ValueType >
auto	entry (const KeyType &key) -> bb::Expected< EntryHandle< S, KeyType, ValueType >, EntryHandleError >
	Creates an [EntryHandle] for direct read access to the value.

Friends
template<ServiceType , typename >
class	PortFactoryReader

Detailed Description

template<ServiceType S, typename KeyType>
class iox2::Reader< S, KeyType >

Reading endpoint of a blackboard based communication.

Definition at line 28 of file reader.hpp.

Constructor & Destructor Documentation

Reader() [1/2]

template<ServiceType S, typename KeyType >

iox2::Reader< S, KeyType >::Reader ( Reader< S, KeyType > &&  rhs )

inlinenoexcept

Definition at line 79 of file reader.hpp.

~Reader()

template<ServiceType S, typename KeyType >

iox2::Reader< S, KeyType >::~Reader ( )

inline

Definition at line 95 of file reader.hpp.

Reader() [2/2]

template<ServiceType S, typename KeyType >

iox2::Reader< S, KeyType >::Reader ( const Reader< S, KeyType > &  )

delete

Member Function Documentation

entry()

template<ServiceType S, typename KeyType >

template<typename ValueType >

auto iox2::Reader< S, KeyType >::entry ( const KeyType &  key ) -> bb::Expected<EntryHandle<S, KeyType, ValueType>, EntryHandleError>

inline

Creates an [EntryHandle] for direct read access to the value.

Definition at line 115 of file reader.hpp.

References iox2::bb::err().

id()

template<ServiceType S, typename KeyType >

auto iox2::Reader< S, KeyType >::id ( ) const -> UniqueReaderId

inline

Returns the [UniqueReaderId] of the [Reader].

Definition at line 100 of file reader.hpp.

name()

template<ServiceType S, typename KeyType >

auto iox2::Reader< S, KeyType >::name ( ) const -> PortNameView

inline

Returns the [PortNameView] of the [Reader].

Definition at line 108 of file reader.hpp.

References iox2::PortNameView::from_native_ptr().

operator=() [1/2]

template<ServiceType S, typename KeyType >

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

delete

operator=() [2/2]

template<ServiceType S, typename KeyType >

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

inlinenoexcept

Definition at line 84 of file reader.hpp.

Friends And Related Symbol Documentation

PortFactoryReader

template<ServiceType S, typename KeyType >

template<ServiceType , typename >

friend class PortFactoryReader

friend

Definition at line 49 of file reader.hpp.

---

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

• iox2/reader.hpp