iox2::Service< S > Class Template Reference

#include <service.hpp>

Static Public Member Functions
static auto	does_exist (const ServiceName &service_name, ConfigView config, MessagingPattern messaging_pattern) -> bb::Expected< bool, ServiceDetailsError >
	Checks if a service under a given [ConfigView] does exist.
static auto	details (const ServiceName &service_name, ConfigView config, MessagingPattern messaging_pattern) -> bb::Expected< bb::Optional< ServiceDetails< S > >, ServiceDetailsError >
	Acquires the [ServiceDetails] of a [Service].
static auto	list (ConfigView config, const iox2::bb::StaticFunction< CallbackProgression(ServiceDetails< S >)> &callback) -> bb::Expected< void, ServiceListError >
	Returns a list of all services created under a given [config::Config].

Detailed Description

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

Represents a service. Used to create or open new services with the [crate::node::Node::service_builder()]. Contains the building blocks a [Service] requires to create the underlying resources and establish communication.

Definition at line 33 of file service.hpp.

Member Function Documentation

details()

template<ServiceType S>

static auto iox2::Service< S >::details ( const ServiceName &  service_name, ConfigView  config, MessagingPattern  messaging_pattern  ) -> bb::Expected< bb::Optional< ServiceDetails< S > >, ServiceDetailsError >

static

Acquires the [ServiceDetails] of a [Service].

does_exist()

template<ServiceType S>

static auto iox2::Service< S >::does_exist ( const ServiceName &  service_name, ConfigView  config, MessagingPattern  messaging_pattern  ) -> bb::Expected< bool, ServiceDetailsError >

static

Checks if a service under a given [ConfigView] does exist.

list()

template<ServiceType S>

static auto iox2::Service< S >::list ( ConfigView  config, const iox2::bb::StaticFunction< CallbackProgression(ServiceDetails< S >)> &  callback  ) -> bb::Expected< void, ServiceListError >

static

Returns a list of all services created under a given [config::Config].

---

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

• iox2/service.hpp