iox2::WaitSetAttachmentId< S > Class Template Reference

Represents an attachment to the [WaitSet]. More...

#include <waitset.hpp>

Public Member Functions
	WaitSetAttachmentId (const WaitSetAttachmentId &rhs)=delete
auto	operator= (const WaitSetAttachmentId &rhs) -> WaitSetAttachmentId &=delete
	WaitSetAttachmentId (WaitSetAttachmentId &&rhs) noexcept
auto	operator= (WaitSetAttachmentId &&rhs) noexcept -> WaitSetAttachmentId &
	~WaitSetAttachmentId ()
auto	has_event_from (const WaitSetGuard< S > &guard) const -> bool
auto	has_missed_deadline (const WaitSetGuard< S > &guard) const -> bool
	Returns true if the deadline for the attachment corresponding to [WaitSetGuard] was missed.
auto	hash () const -> std::size_t
	Returns the a non-secure hash for the [WaitSetAttachmentId].

Static Public Member Functions
static auto	from_guard (const WaitSetGuard< S > &guard) -> WaitSetAttachmentId

Friends
template<ServiceType >
auto	run_callback (iox2_waitset_attachment_id_h, void *) -> iox2_callback_progression_e
template<ServiceType ST>
auto	operator== (const WaitSetAttachmentId< ST > &, const WaitSetAttachmentId< ST > &) -> bool
template<ServiceType ST>
auto	operator< (const WaitSetAttachmentId< ST > &, const WaitSetAttachmentId< ST > &) -> bool
template<ServiceType ST>
auto	operator<< (std::ostream &stream, const WaitSetAttachmentId< ST > &self) -> std::ostream &

Detailed Description

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

Represents an attachment to the [WaitSet].

Definition at line 57 of file waitset.hpp.

Constructor & Destructor Documentation

WaitSetAttachmentId() [1/2]

template<ServiceType S>

iox2::WaitSetAttachmentId< S >::WaitSetAttachmentId ( const WaitSetAttachmentId< S > &  rhs )

delete

WaitSetAttachmentId() [2/2]

template<ServiceType S>

iox2::WaitSetAttachmentId< S >::WaitSetAttachmentId ( WaitSetAttachmentId< S > &&  rhs )

noexcept

~WaitSetAttachmentId()

template<ServiceType S>

iox2::WaitSetAttachmentId< S >::~WaitSetAttachmentId

(

)

Member Function Documentation

from_guard()

template<ServiceType S>

static auto iox2::WaitSetAttachmentId< S >::from_guard ( const WaitSetGuard< S > &  guard ) -> WaitSetAttachmentId

static

Creates an [WaitSetAttachmentId] from a [WaitSetGuard] that was returned via [WaitSet::attach_interval()], [WaitSet::attach_notification()] or [WaitSet::attach_deadline()].

has_event_from()

template<ServiceType S>

auto iox2::WaitSetAttachmentId< S >::has_event_from

(

const WaitSetGuard< S > &

guard

)

const -> bool

Returns true if an event was emitted from a notification or deadline attachment corresponding to [WaitSetGuard].

has_missed_deadline()

template<ServiceType S>

auto iox2::WaitSetAttachmentId< S >::has_missed_deadline

(

const WaitSetGuard< S > &

guard

)

const -> bool

Returns true if the deadline for the attachment corresponding to [WaitSetGuard] was missed.

hash()

template<ServiceType S>

auto iox2::WaitSetAttachmentId< S >::hash

(

)

const -> std::size_t

Returns the a non-secure hash for the [WaitSetAttachmentId].

operator=() [1/2]

template<ServiceType S>

auto iox2::WaitSetAttachmentId< S >::operator= ( const WaitSetAttachmentId< S > &  rhs ) -> WaitSetAttachmentId &=delete

delete

operator=() [2/2]

template<ServiceType S>

auto iox2::WaitSetAttachmentId< S >::operator= ( WaitSetAttachmentId< S > &&  rhs ) -> WaitSetAttachmentId &

noexcept

Friends And Related Symbol Documentation

operator<

template<ServiceType S>

template<ServiceType ST>

auto operator< ( const WaitSetAttachmentId< ST > &  , const WaitSetAttachmentId< ST > &    ) -> bool

friend

operator<<

template<ServiceType S>

template<ServiceType ST>

auto operator<< ( std::ostream &  stream, const WaitSetAttachmentId< ST > &  self  ) -> std::ostream &

friend

operator==

template<ServiceType S>

template<ServiceType ST>

auto operator== ( const WaitSetAttachmentId< ST > &  , const WaitSetAttachmentId< ST > &    ) -> bool

friend

run_callback

template<ServiceType S>

template<ServiceType >

auto run_callback ( iox2_waitset_attachment_id_h  , void *    ) -> iox2_callback_progression_e

friend

---

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

• iox2/waitset.hpp