iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
iox2::ServiceBuilderBlackboardCreator< KeyType, S > Class Template Reference

Builder to create new [MessagingPattern::Blackboard] based [Service]s. More...

#include <service_builder_blackboard.hpp>

Public Member Functions

auto max_readers (const uint64_t value) -> decltype(auto)
 Defines how many [Reader]s shall be supported at most.
 
auto max_nodes (const uint64_t value) -> decltype(auto)
 Defines how many [Node]s shall be able to open it in parallel.
 
template<typename ValueType >
auto add (KeyType key, ValueType value) -> ServiceBuilderBlackboardCreator &&
 Adds key-value pairs to the blackboard.
 
template<typename ValueType >
auto add_with_default (KeyType key) -> ServiceBuilderBlackboardCreator &&
 Adds key-value pairs to the blackboard where value is a default value.
 
auto create () &&-> bb::Expected< PortFactoryBlackboard< S, KeyType >, BlackboardCreateError >
 Creates a new [Service].
 
auto create_with_attributes (const AttributeSpecifier &attributes) &&-> bb::Expected< PortFactoryBlackboard< S, KeyType >, BlackboardCreateError >
 Creates a new [Service] with a set of attributes.
 

Friends

template<ServiceType >
class ServiceBuilder
 

Detailed Description

template<typename KeyType, ServiceType S>
class iox2::ServiceBuilderBlackboardCreator< KeyType, S >

Builder to create new [MessagingPattern::Blackboard] based [Service]s.

Definition at line 31 of file service_builder_blackboard.hpp.

Member Function Documentation

◆ add()

template<typename KeyType , ServiceType S>
template<typename ValueType >
auto iox2::ServiceBuilderBlackboardCreator< KeyType, S >::add ( KeyType  key,
ValueType  value 
) -> ServiceBuilderBlackboardCreator&&
inline

Adds key-value pairs to the blackboard.

Definition at line 157 of file service_builder_blackboard.hpp.

◆ add_with_default()

template<typename KeyType , ServiceType S>
template<typename ValueType >
auto iox2::ServiceBuilderBlackboardCreator< KeyType, S >::add_with_default ( KeyType  key) -> ServiceBuilderBlackboardCreator&&
inline

Adds key-value pairs to the blackboard where value is a default value.

Definition at line 188 of file service_builder_blackboard.hpp.

◆ create()

template<typename KeyType , ServiceType S>
auto iox2::ServiceBuilderBlackboardCreator< KeyType, S >::create ( ) && -> bb::Expected<PortFactoryBlackboard<S, KeyType>, BlackboardCreateError>
inline

Creates a new [Service].

Definition at line 194 of file service_builder_blackboard.hpp.

References iox2::bb::err().

◆ create_with_attributes()

template<typename KeyType , ServiceType S>
auto iox2::ServiceBuilderBlackboardCreator< KeyType, S >::create_with_attributes ( const AttributeSpecifier attributes) && -> bb::Expected<PortFactoryBlackboard<S, KeyType>, BlackboardCreateError>
inline

Creates a new [Service] with a set of attributes.

Definition at line 209 of file service_builder_blackboard.hpp.

References iox2::bb::err().

◆ max_nodes()

template<typename KeyType , ServiceType S>
auto iox2::ServiceBuilderBlackboardCreator< KeyType, S >::max_nodes ( const uint64_t  value) -> decltype(auto)

Defines how many [Node]s shall be able to open it in parallel.

◆ max_readers()

template<typename KeyType , ServiceType S>
auto iox2::ServiceBuilderBlackboardCreator< KeyType, S >::max_readers ( const uint64_t  value) -> decltype(auto)

Defines how many [Reader]s shall be supported at most.

Friends And Related Symbol Documentation

◆ ServiceBuilder

template<typename KeyType , ServiceType S>
template<ServiceType >
friend class ServiceBuilder
friend

Definition at line 74 of file service_builder_blackboard.hpp.


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