Skip to content

TConfig.TService

All configurable settings of a TService.

Definition

Unit: Neslib.Iceoryx2.Types

type TService = record ... end;

Properties

Name Description
CleanupDeadNodesOnOpen When True, the TServiceBuilder will clean up dead nodes when opening an existing service.
ConnectionSuffix The suffix of a one-to-one connection
DataSegmentSuffix The suffix of the ports data segment
Directory The directory in which all service files are stored
DynamicConfigStorageSuffix The suffix of the dynamic config file
EventConnectionSuffix The suffix of an event connection
FlatbufferSchemaPath A list of directories where iceoryx2 will look for .fbs flatbuffer schemas. If no path is provided, iceoryx2 will perform no lookup and the user must explicitly define the path to the flatbuffer schemas.
StaticConfigStorageSuffix The suffix of the static config file

Property Descriptions

CleanupDeadNodesOnOpen

When True, the TServiceBuilder will clean up dead nodes when opening an existing service.

property CleanupDeadNodesOnOpen: Boolean read GetCleanupDeadNodesOnOpen write SetCleanupDeadNodesOnOpen

Type: Boolean


ConnectionSuffix

The suffix of a one-to-one connection

property ConnectionSuffix: String read GetConnectionSuffix write SetConnectionSuffix

Type: String


DataSegmentSuffix

The suffix of the ports data segment

property DataSegmentSuffix: String read GetDataSegmentSuffix write SetDataSegmentSuffix

Type: String


Directory

The directory in which all service files are stored

property Directory: String read GetDirectory write SetDirectory

Type: String


DynamicConfigStorageSuffix

The suffix of the dynamic config file

property DynamicConfigStorageSuffix: String read GetDynamicConfigStorageSuffix write SetDynamicConfigStorageSuffix

Type: String


EventConnectionSuffix

The suffix of an event connection

property EventConnectionSuffix: String read GetEventConnectionSuffix write SetEventConnectionSuffix

Type: String


FlatbufferSchemaPath

A list of directories where iceoryx2 will look for .fbs flatbuffer schemas. If no path is provided, iceoryx2 will perform no lookup and the user must explicitly define the path to the flatbuffer schemas.

property FlatbufferSchemaPath: String read GetFlatbufferSchemaPath write SetFlatbufferSchemaPath

Type: String


StaticConfigStorageSuffix

The suffix of the static config file

property StaticConfigStorageSuffix: String read GetStaticConfigStorageSuffix write SetStaticConfigStorageSuffix

Type: String