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

#include <event_activation.hpp>

Public Member Functions

 EventActivation (const EventActivation &)=default
 
 EventActivation (EventActivation &&)=default
 
auto operator= (const EventActivation &) -> EventActivation &=default
 
auto operator= (EventActivation &&) -> EventActivation &=default
 
 ~EventActivation ()=default
 
auto id () const -> EventId
 Returns the event identifier of this activation.
 
auto count () const -> uint64_t
 Returns the number of event activations associated with this identifier.
 

Friends

auto operator<< (std::ostream &stream, const EventActivation &value) -> std::ostream &
 
void wait_callback (const iox2_event_id_t *, uint64_t, iox2_callback_context)
 

Detailed Description

Represents a single event activation with its identifier and activation count.

This class is returned by event listening operations and carries the event's unique identifier along with the number of pending activations for that event.

Definition at line 24 of file event_activation.hpp.

Constructor & Destructor Documentation

◆ EventActivation() [1/2]

iox2::EventActivation::EventActivation ( const EventActivation )
default

◆ EventActivation() [2/2]

iox2::EventActivation::EventActivation ( EventActivation &&  )
default

◆ ~EventActivation()

iox2::EventActivation::~EventActivation ( )
default

Member Function Documentation

◆ count()

auto iox2::EventActivation::count ( ) const -> uint64_t

Returns the number of event activations associated with this identifier.

◆ id()

auto iox2::EventActivation::id ( ) const -> EventId

Returns the event identifier of this activation.

◆ operator=() [1/2]

auto iox2::EventActivation::operator= ( const EventActivation ) -> EventActivation &=default
default

◆ operator=() [2/2]

auto iox2::EventActivation::operator= ( EventActivation &&  ) -> EventActivation &=default
default

Friends And Related Symbol Documentation

◆ operator<<

auto operator<< ( std::ostream &  stream,
const EventActivation value 
) -> std::ostream &
friend

◆ wait_callback

void wait_callback ( const iox2_event_id_t *  event_id,
uint64_t  event_count,
iox2_callback_context  context 
)
friend

Definition at line 166 of file listener.hpp.


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