iox2::PortFactoryEvent< S > Class Template Reference

Represents the port factory of a [Service] with [MessagingPattern::Event]. More...

#include <port_factory_event.hpp>

Public Member Functions
	PortFactoryEvent (PortFactoryEvent &&) noexcept
auto	operator= (PortFactoryEvent &&) noexcept -> PortFactoryEvent &
	~PortFactoryEvent ()
	PortFactoryEvent (const PortFactoryEvent &)=delete
auto	operator= (const PortFactoryEvent &) -> PortFactoryEvent &=delete
auto	name () const -> ServiceNameView
	Returns the [ServiceName] of the service.
auto	service_hash () const -> ServiceHash
	Returns the [ServiceHash] of the [Service].
auto	attributes () const -> AttributeSetView
	Returns the attributes defined in the [Service].
auto	static_config () const -> StaticConfigEvent
auto	dynamic_config () const -> DynamicConfigEvent
auto	nodes (const iox2::bb::StaticFunction< CallbackProgression(NodeState< S >)> &callback) const -> bb::Expected< void, NodeListFailure >
auto	listener_builder () const -> PortFactoryListener< S >
	Returns a [PortFactoryListener] to create a new [Listener] port.
auto	notifier_builder () const -> PortFactoryNotifier< S >
	Returns a [PortFactoryNotifier] to create a new [Notifier] port.
auto	try_cleanup_dead_nodes () const -> CleanupState
auto	blocking_cleanup_dead_nodes (iox2::bb::Duration timeout) const -> CleanupState

Friends
template<ServiceType >
class	ServiceBuilderEvent

Detailed Description

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

Represents the port factory of a [Service] with [MessagingPattern::Event].

Definition at line 35 of file port_factory_event.hpp.

Constructor & Destructor Documentation

PortFactoryEvent() [1/2]

template<ServiceType S>

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

noexcept

~PortFactoryEvent()

template<ServiceType S>

iox2::PortFactoryEvent< S >::~PortFactoryEvent

(

)

PortFactoryEvent() [2/2]

template<ServiceType S>

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

delete

Member Function Documentation

attributes()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::attributes

(

)

const -> AttributeSetView

Returns the attributes defined in the [Service].

blocking_cleanup_dead_nodes()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::blocking_cleanup_dead_nodes

(

iox2::bb::Duration

timeout

)

const -> CleanupState

Removes the stale system resources of all dead [Node]s connected to this service.

If a [Node] cannot be cleaned up since the process has insufficient permissions then the [Node] is skipped. If it is currently being cleaned up by another process then the cleaner will wait until the timeout as either passed or the cleaned was finished.

The timeout is applied to every individual dead [Node] the function needs to wait on.

dynamic_config()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::dynamic_config

(

)

const -> DynamicConfigEvent

Returns the DynamicConfig of the [Service]. Contains all dynamic settings, like the current participants etc..

listener_builder()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::listener_builder

(

)

const -> PortFactoryListener< S >

Returns a [PortFactoryListener] to create a new [Listener] port.

name()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::name

(

)

const -> ServiceNameView

Returns the [ServiceName] of the service.

nodes()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::nodes

(

const iox2::bb::StaticFunction< CallbackProgression(NodeState< S >)> &

callback

)

const -> bb::Expected< void, NodeListFailure >

Iterates over all [Node]s of the [Service] and calls for every [Node] the provided callback. If an error occurs while acquiring the [Node]s corresponding [NodeState] the error is forwarded to the callback as input argument.

notifier_builder()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::notifier_builder

(

)

const -> PortFactoryNotifier< S >

Returns a [PortFactoryNotifier] to create a new [Notifier] port.

operator=() [1/2]

template<ServiceType S>

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

delete

operator=() [2/2]

template<ServiceType S>

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

noexcept

service_hash()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::service_hash

(

)

const -> ServiceHash

Returns the [ServiceHash] of the [Service].

static_config()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::static_config

(

)

const -> StaticConfigEvent

Returns the StaticConfig of the [Service]. Contains all settings that never change during the lifetime of the service.

try_cleanup_dead_nodes()

template<ServiceType S>

auto iox2::PortFactoryEvent< S >::try_cleanup_dead_nodes

(

)

const -> CleanupState

Removes the stale system resources of all dead [Node]s connected to this service.

If a [Node] cannot be cleaned up since the process has insufficient permissions or it is currently being cleaned up by another process then the [Node] is skipped.

Friends And Related Symbol Documentation

ServiceBuilderEvent

template<ServiceType S>

template<ServiceType >

friend class ServiceBuilderEvent

friend

Definition at line 91 of file port_factory_event.hpp.

---

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

• iox2/port_factory_event.hpp