Skip to content

TServiceBuilderBlackboardCreator<TKey>

Builder to create new TMessagingPattern.Blackboard based services that create a blackboard.

Definition

Unit: Neslib.Iceoryx2.Blackboard

type TServiceBuilderBlackboardCreator<TKey> = record ... end;

Type Parameters

TKey:

Methods

Name Description
_Init
Add<TValue> Adds key-value pairs to the blackboard.
AddWithDefault<TValue> Adds key-value pairs to the blackboard where value is a default value.
Create Creates a new service.
CreateWithAttributes Creates a new service with a set of attributes.
MaxNodes Defines how many TNode's shall be able to open it in parallel.
MaxReaders Defines how many TReader's shall be supported at most.

Method Descriptions

_Init(_iox2_service_builder_h, TServiceType, TKeyEqualityFunc<TKey>)

procedure _Init(const AHandle: _iox2_service_builder_h; const AServiceType: TServiceType; const AKeyEqualityFunc: TKeyEqualityFunc<TKey>); inline

Parameters

AHandle: _iox2_service_builder_h

AServiceType: TServiceType

AKeyEqualityFunc: TKeyEqualityFunc<TKey>


Add<TValue>(TKey, TValue)

Adds key-value pairs to the blackboard.

function Add<TValue>(const AKey: TKey; const AValue: TValue): TServiceBuilderBlackboardCreator<TKey>; inline

Type Parameters

TValue:

Parameters

AKey: TKey

AValue: TValue

Returns

TServiceBuilderBlackboardCreator<TKey>


AddWithDefault<TValue>(TKey)

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

function AddWithDefault<TValue>(const AKey: TKey): TServiceBuilderBlackboardCreator<TKey>; inline

Type Parameters

TValue:

Parameters

AKey: TKey

Returns

TServiceBuilderBlackboardCreator<TKey>


Create

Creates a new service.

function Create: TResult<TPortFactoryBlackboard<TKey>, TBlackboardCreateError>

Returns

TResult<TPortFactoryBlackboard<TKey>, TBlackboardCreateError>


CreateWithAttributes(TAttributeSpecifier)

Creates a new service with a set of attributes.

function CreateWithAttributes(const AAttributes: TAttributeSpecifier): TResult<TPortFactoryBlackboard<TKey>, TBlackboardCreateError>

Parameters

AAttributes: TAttributeSpecifier

Returns

TResult<TPortFactoryBlackboard<TKey>, TBlackboardCreateError>


MaxNodes(Int64)

Defines how many TNode's shall be able to open it in parallel.

function MaxNodes(const AValue: Int64): TServiceBuilderBlackboardCreator<TKey>; inline

Parameters

AValue: Int64

Returns

TServiceBuilderBlackboardCreator<TKey>


MaxReaders(Int64)

Defines how many TReader's shall be supported at most.

function MaxReaders(const AValue: Int64): TServiceBuilderBlackboardCreator<TKey>; inline

Parameters

AValue: Int64

Returns

TServiceBuilderBlackboardCreator<TKey>