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

#include <waitset.hpp>

Public Member Functions

 WaitSetGuard (WaitSetGuard &&) noexcept
 
auto operator= (WaitSetGuard &&rhs) noexcept -> WaitSetGuard &
 
 ~WaitSetGuard ()
 
 WaitSetGuard (const WaitSetGuard &)=delete
 
auto operator= (const WaitSetGuard &)=delete
 

Friends

template<ServiceType >
class WaitSet
 
template<ServiceType >
class WaitSetAttachmentId
 

Detailed Description

template<ServiceType S>
class iox2::WaitSetGuard< S >

The [WaitSetGuard] is returned by [WaitSet::attach_deadline()], [WaitSet::attach_notification()] or [WaitSet::attach_interval()]. As soon as it goes out-of-scope it detaches the attachment. It can also be used to determine the origin of an event in [WaitSet::wait_and_process()] or [WaitSet::try_wait_and_process()] via [WaitSetAttachmentId::has_event_from()] or [WaitSetAttachmentId::has_missed_deadline()].

Definition at line 34 of file waitset.hpp.

Constructor & Destructor Documentation

◆ WaitSetGuard() [1/2]

template<ServiceType S>
iox2::WaitSetGuard< S >::WaitSetGuard ( WaitSetGuard< S > &&  )
noexcept

◆ ~WaitSetGuard()

◆ WaitSetGuard() [2/2]

template<ServiceType S>
iox2::WaitSetGuard< S >::WaitSetGuard ( const WaitSetGuard< S > &  )
delete

Member Function Documentation

◆ operator=() [1/2]

template<ServiceType S>
auto iox2::WaitSetGuard< S >::operator= ( const WaitSetGuard< S > &  )
delete

◆ operator=() [2/2]

template<ServiceType S>
auto iox2::WaitSetGuard< S >::operator= ( WaitSetGuard< S > &&  rhs) -> WaitSetGuard &
noexcept

Friends And Related Symbol Documentation

◆ WaitSet

template<ServiceType S>
template<ServiceType >
friend class WaitSet
friend

Definition at line 45 of file waitset.hpp.

◆ WaitSetAttachmentId

template<ServiceType S>
template<ServiceType >
friend class WaitSetAttachmentId
friend

Definition at line 48 of file waitset.hpp.


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