iox2::StaticConfig Class Reference

Defines a common set of static service configuration details every service shares. More...

#include <static_config.hpp>

Public Member Functions
	StaticConfig (const StaticConfig &)=delete
	StaticConfig (StaticConfig &&rhs) noexcept
	~StaticConfig ()
auto	operator= (const StaticConfig &) -> StaticConfig &=delete
auto	operator= (StaticConfig &&rhs) noexcept -> StaticConfig &
auto	attributes () const -> AttributeSetView
	Returns the attributes of the [Service].
auto	id () const -> const char *
	Returns the id of the [Service].
auto	name () const -> const char *
	Returns the [ServiceName] of the [Service].
auto	messaging_pattern () const -> MessagingPattern
	Returns the [MessagingPattern] of the [Service].
auto	blackboard () const -> StaticConfigBlackboard
auto	event () const -> StaticConfigEvent
auto	publish_subscribe () const -> StaticConfigPublishSubscribe
auto	request_response () const -> StaticConfigRequestResponse

Friends
template<ServiceType >
class	Service
template<ServiceType >
auto	list_callback (const iox2_static_config_t *, void *) -> iox2_callback_progression_e

Detailed Description

Defines a common set of static service configuration details every service shares.

Definition at line 25 of file static_config.hpp.

Constructor & Destructor Documentation

StaticConfig() [1/2]

iox2::StaticConfig::StaticConfig ( const StaticConfig &  )

delete

StaticConfig() [2/2]

iox2::StaticConfig::StaticConfig ( StaticConfig &&  rhs )

noexcept

~StaticConfig()

iox2::StaticConfig::~StaticConfig

(

)

Member Function Documentation

attributes()

auto iox2::StaticConfig::attributes

(

)

const -> AttributeSetView

Returns the attributes of the [Service].

blackboard()

auto iox2::StaticConfig::blackboard

(

)

const -> StaticConfigBlackboard

Returns the [StaticConfigBlackboard].

Safety

• Ensure that [StaticConfig::messaging_pattern()] == [MessagingPattern::Blackboard].

event()

auto iox2::StaticConfig::event

(

)

const -> StaticConfigEvent

Returns the [StaticConfigEvent].

Safety

• Ensure that [StaticConfig::messaging_pattern()] == [MessagingPattern::Event].

id()

auto iox2::StaticConfig::id

(

)

const -> const char *

Returns the id of the [Service].

messaging_pattern()

auto iox2::StaticConfig::messaging_pattern

(

)

const -> MessagingPattern

Returns the [MessagingPattern] of the [Service].

name()

auto iox2::StaticConfig::name

(

)

const -> const char *

Returns the [ServiceName] of the [Service].

operator=() [1/2]

auto iox2::StaticConfig::operator= ( const StaticConfig &  ) -> StaticConfig &=delete

delete

operator=() [2/2]

auto iox2::StaticConfig::operator= ( StaticConfig &&  rhs ) -> StaticConfig &

noexcept

publish_subscribe()

auto iox2::StaticConfig::publish_subscribe

(

)

const -> StaticConfigPublishSubscribe

Returns the [StaticConfigPublishSubscribe].

Safety

• Ensure that [StaticConfig::messaging_pattern()] == [MessagingPattern::PublishSubscribe].

request_response()

auto iox2::StaticConfig::request_response

(

)

const -> StaticConfigRequestResponse

Returns the [StaticConfigRequestResponse].

Safety

• Ensure that [StaticConfig::messaging_pattern()] == [MessagingPattern::RequestResponse].

Friends And Related Symbol Documentation

list_callback

template<ServiceType >

auto list_callback ( const iox2_static_config_t *  , void *    ) -> iox2_callback_progression_e

friend

Service

template<ServiceType >

friend class Service

friend

Definition at line 76 of file static_config.hpp.

---

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

• iox2/static_config.hpp