iox2::Notifier< S > Class Template Reference

Represents the sending endpoint of an event based communication. More...

#include <notifier.hpp>

Public Member Functions
	Notifier (Notifier &&) noexcept
auto	operator= (Notifier &&) noexcept -> Notifier &
	~Notifier ()
	Notifier (const Notifier &)=delete
auto	operator= (const Notifier &) -> Notifier &=delete
auto	id () const -> UniqueNotifierId
	Returns the [UniqueNotifierId] of the [Notifier].
auto	notify () const -> bb::Expected< size_t, NotifierNotifyError >
auto	notify_with_custom_event_id (EventId event_id) const -> bb::Expected< size_t, NotifierNotifyError >
auto	deadline () const -> bb::Optional< iox2::bb::Duration >
	Returns the deadline of the corresponding [Service].

Friends
template<ServiceType >
class	PortFactoryNotifier

Detailed Description

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

Represents the sending endpoint of an event based communication.

Definition at line 28 of file notifier.hpp.

Constructor & Destructor Documentation

Notifier() [1/2]

template<ServiceType S>

iox2::Notifier< S >::Notifier ( Notifier< S > &&  )

noexcept

~Notifier()

template<ServiceType S>

iox2::Notifier< S >::~Notifier

(

)

Notifier() [2/2]

template<ServiceType S>

iox2::Notifier< S >::Notifier ( const Notifier< S > &  )

delete

Member Function Documentation

deadline()

template<ServiceType S>

auto iox2::Notifier< S >::deadline

(

)

const -> bb::Optional< iox2::bb::Duration >

Returns the deadline of the corresponding [Service].

id()

template<ServiceType S>

auto iox2::Notifier< S >::id

(

)

const -> UniqueNotifierId

Returns the [UniqueNotifierId] of the [Notifier].

notify()

template<ServiceType S>

auto iox2::Notifier< S >::notify

(

)

const -> bb::Expected< size_t, NotifierNotifyError >

Notifies all [Listener] connected to the service with the default event id provided on creation. Returns on success the number of [Listener]s that were notified otherwise it returns [NotifierNotifyError].

notify_with_custom_event_id()

template<ServiceType S>

auto iox2::Notifier< S >::notify_with_custom_event_id

(

EventId

event_id

)

const -> bb::Expected< size_t, NotifierNotifyError >

Notifies all [Listener] connected to the service with a custom [EventId]. Returns on success the number of [Listener]s that were notified otherwise it returns [NotifierNotifyError].

operator=() [1/2]

template<ServiceType S>

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

delete

operator=() [2/2]

template<ServiceType S>

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

noexcept

Friends And Related Symbol Documentation

PortFactoryNotifier

template<ServiceType S>

template<ServiceType >

friend class PortFactoryNotifier

friend

Definition at line 56 of file notifier.hpp.

---

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

• iox2/notifier.hpp