iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::Writer< S, KeyType > Class Template Reference

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

#include <writer.hpp>

Public Member Functions

 Writer (Writer &&rhs) noexcept
 
auto operator= (Writer &&rhs) noexcept -> Writer &
 
 ~Writer ()
 
 Writer (const Writer &)=delete
 
auto operator= (const Writer &) -> Writer &=delete
 
auto id () const -> UniqueWriterId
 Returns the [UniqueWriterId] of the [Writer].
 
template<typename ValueType >
auto entry (const KeyType &key) -> bb::Expected< EntryHandleMut< S, KeyType, ValueType >, EntryHandleMutError >
 

Friends

template<ServiceType , typename >
class PortFactoryWriter
 

Detailed Description

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

Producing endpoint of a blackboard based communication.

Definition at line 26 of file writer.hpp.

Constructor & Destructor Documentation

◆ Writer() [1/2]

template<ServiceType S, typename KeyType >
iox2::Writer< S, KeyType >::Writer ( Writer< S, KeyType > &&  rhs)
inlinenoexcept

Definition at line 67 of file writer.hpp.

◆ ~Writer()

template<ServiceType S, typename KeyType >
iox2::Writer< S, KeyType >::~Writer ( )
inline

Definition at line 83 of file writer.hpp.

◆ Writer() [2/2]

template<ServiceType S, typename KeyType >
iox2::Writer< S, KeyType >::Writer ( const Writer< S, KeyType > &  )
delete

Member Function Documentation

◆ entry()

template<ServiceType S, typename KeyType >
template<typename ValueType >
auto iox2::Writer< S, KeyType >::entry ( const KeyType &  key) -> bb::Expected<EntryHandleMut<S, KeyType, ValueType>, EntryHandleMutError>
inline

Creates an [EntryHandleMut] for direct write access to the value. There can be only one [EntryHandleMut] per value.

Definition at line 97 of file writer.hpp.

References iox2::bb::err().

◆ id()

template<ServiceType S, typename KeyType >
auto iox2::Writer< S, KeyType >::id ( ) const -> UniqueWriterId
inline

Returns the [UniqueWriterId] of the [Writer].

Definition at line 88 of file writer.hpp.

◆ operator=() [1/2]

template<ServiceType S, typename KeyType >
auto iox2::Writer< S, KeyType >::operator= ( const Writer< S, KeyType > &  ) -> Writer &=delete
delete

◆ operator=() [2/2]

template<ServiceType S, typename KeyType >
auto iox2::Writer< S, KeyType >::operator= ( Writer< S, KeyType > &&  rhs) -> Writer&
inlinenoexcept

Definition at line 72 of file writer.hpp.

Friends And Related Symbol Documentation

◆ PortFactoryWriter

template<ServiceType S, typename KeyType >
template<ServiceType , typename >
friend class PortFactoryWriter
friend

Definition at line 45 of file writer.hpp.


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