TConfig
Represents the configuration that iceoryx2 will utilize. It is divided into two sections: * [Global] settings, which must align with the iceoryx2 instance the application intends to join * [Defaults] for communication within that iceoryx2 instance. The user has the flexibility to override both sections.
Definition
Unit: Neslib.Iceoryx2.Types
Nested Types
| Name | Description |
|---|---|
| TBlackboard | Default settings for the blackboard messaging pattern. These settings are used unless the user specifies custom QoS or port settings. |
| TDefaults | Default settings. These values are used when the user in the code does not specify anything else. |
| TEvent | Default settings for the event messaging pattern. These settings are used unless the user specifies custom QoS or port settings. |
| TGlobal | The global settings |
| TNode | All configurable settings of a TNode. |
| TPublishSubscribe | Default settings for the publish-subscribe messaging pattern. These settings are used unless the user specifies custom QoS or port settings. |
| TRequestResponse | Default settings for the request response messaging pattern. These settings are used unless the user specifies custom QoS or port settings. |
| TService | All configurable settings of a TService. |
Properties
| Name | Description |
|---|---|
| Defaults | Returns the TConfig.Defaults part of the config |
| Global | Returns the Config.Global part of the config |
| GlobalConfig | Returns a TConfigView to the current global config. |
| Handle | |
| View | Returns the TConfigView to this TConfig |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Create | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
Methods
| Name | Description |
|---|---|
| FromFile | Loads a configuration from a file. On success it returns a TConfig object otherwise a TConfigCreationError describing the failure. |
| SetupGlobalConfigFromFile | Sets the global configuration from a file. On success it returns the global config as a TConfigView object otherwise a TConfigCreationError describing the failure. |
Property Descriptions
Defaults
Returns the TConfig.Defaults part of the config
property Defaults: TDefaults read GetDefaults
Type: TDefaults
Global
Returns the Config.Global part of the config
property Global: TGlobal read GetGlobal
Type: TGlobal
GlobalConfig
Returns a TConfigView to the current global config.
class property GlobalConfig: TConfigView read GetGlobalConfig
Type: TConfigView
Handle
property Handle: THandle read GetHandle
Type: THandle
View
Returns the TConfigView to this TConfig
property View: TConfigView read GetView
Type: TConfigView
Constructor Descriptions
Assign
constructor Assign(var ADest: TConfig; const ASrc: TConfig)
Parameters
ADest: TConfig
ASrc: TConfig
Create
constructor Create(const AHandle: THandle)
Parameters
AHandle: THandle
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TConfig, Pointer)
class operator Equal(const ALeft: TConfig; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TConfig
ARight: Pointer
Returns
Boolean
NotEqual(TConfig, Pointer)
class operator NotEqual(const ALeft: TConfig; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TConfig
ARight: Pointer
Returns
Boolean
Method Descriptions
FromFile(String)
Loads a configuration from a file. On success it returns a TConfig object otherwise a TConfigCreationError describing the failure.
class function FromFile(const APath: String): TResult<TConfig, TConfigCreationError>; static
Parameters
APath: String
Returns
TResult<TConfig, TConfigCreationError>
SetupGlobalConfigFromFile(String)
Sets the global configuration from a file. On success it returns the global config as a TConfigView object otherwise a TConfigCreationError describing the failure.
class function SetupGlobalConfigFromFile(const APath: String): TResult<TConfigView, TConfigCreationError>; static
Parameters
APath: String
Returns
TResult<TConfigView, TConfigCreationError>