iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::WaitSetBuilder Class Reference

The builder for the [WaitSet]. More...

#include <waitset.hpp>

Public Member Functions

auto signal_handling_mode (const SignalHandlingMode value) -> decltype(auto)
 
 WaitSetBuilder ()
 
 ~WaitSetBuilder ()=default
 
 WaitSetBuilder (const WaitSetBuilder &)=delete
 
 WaitSetBuilder (WaitSetBuilder &&)=delete
 
auto operator= (const WaitSetBuilder &) -> WaitSetBuilder &=delete
 
auto operator= (WaitSetBuilder &&) -> WaitSetBuilder &=delete
 
template<ServiceType S>
auto create () const &&-> bb::Expected< WaitSet< S >, WaitSetCreateError >
 Creates the [WaitSet].
 

Detailed Description

The builder for the [WaitSet].

Definition at line 258 of file waitset.hpp.

Constructor & Destructor Documentation

◆ WaitSetBuilder() [1/3]

iox2::WaitSetBuilder::WaitSetBuilder ( )

◆ ~WaitSetBuilder()

iox2::WaitSetBuilder::~WaitSetBuilder ( )
default

◆ WaitSetBuilder() [2/3]

iox2::WaitSetBuilder::WaitSetBuilder ( const WaitSetBuilder )
delete

◆ WaitSetBuilder() [3/3]

iox2::WaitSetBuilder::WaitSetBuilder ( WaitSetBuilder &&  )
delete

Member Function Documentation

◆ create()

template<ServiceType S>
auto iox2::WaitSetBuilder::create ( ) const && -> bb::Expected< WaitSet< S >, WaitSetCreateError >

Creates the [WaitSet].

◆ operator=() [1/2]

auto iox2::WaitSetBuilder::operator= ( const WaitSetBuilder ) -> WaitSetBuilder &=delete
delete

◆ operator=() [2/2]

auto iox2::WaitSetBuilder::operator= ( WaitSetBuilder &&  ) -> WaitSetBuilder &=delete
delete

◆ signal_handling_mode()

auto iox2::WaitSetBuilder::signal_handling_mode ( const SignalHandlingMode  value) -> decltype(auto)

Defines the [SignalHandlingMode] for the [WaitSet]. It affects the [WaitSet::wait_and_process()] and [WaitSet::wait_and_process_once()] calls that returns any received [Signal] via its [WaitSetRunResult] return value.


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