Skip to content

TStaticConfigEvent

The static configuration of a TMessagingPattern.Event based service. Contains all parameters that do not change during the lifetime of a Service.

Definition

Unit: Neslib.Iceoryx2.Event

type TStaticConfigEvent = record ... end;

Properties

Name Description
Deadline Returns the deadline of the service. If no new notification is signaled from any TNotifier after the given deadline, it is rated as an error and all TListener's that are attached to a TWaitSet are woken up and notified about the missed deadline.
EventIdMaxValue Returns the largest TEventId that is supported by the service
MaxListeners Returns the maximum supported amount of TListener ports
MaxNodes Returns the maximum supported amount of TNode's that can open the service in parallel.
MaxNotifiers Returns the maximum supported amount of TNotifier ports
NotifierCreatedEvent Returns the emitted TEventId when a new notifier is created.
NotifierDeadEvent Returns the emitted TEventId when a notifier is identified as dead.
NotifierDroppedEvent Returns the emitted TEventId when a notifier is dropped.

Methods

Name Description
ToString Returns a string representation of the config.

Property Descriptions

Deadline

Returns the deadline of the service. If no new notification is signaled from any TNotifier after the given deadline, it is rated as an error and all TListener's that are attached to a TWaitSet are woken up and notified about the missed deadline.

property Deadline: Nullable<TDuration> read GetDeadline

Type: Nullable<TDuration>


EventIdMaxValue

Returns the largest TEventId that is supported by the service

property EventIdMaxValue: NativeUInt read FValue.event_id_max_value

Type: NativeUInt


MaxListeners

Returns the maximum supported amount of TListener ports

property MaxListeners: NativeInt read FValue.max_listeners

Type: NativeInt


MaxNodes

Returns the maximum supported amount of TNode's that can open the service in parallel.

property MaxNodes: NativeInt read FValue.max_nodes

Type: NativeInt


MaxNotifiers

Returns the maximum supported amount of TNotifier ports

property MaxNotifiers: NativeInt read FValue.max_notifiers

Type: NativeInt


NotifierCreatedEvent

Returns the emitted TEventId when a new notifier is created.

property NotifierCreatedEvent: Nullable<TEventId> read GetNotifierCreatedEvent

Type: Nullable<TEventId>


NotifierDeadEvent

Returns the emitted TEventId when a notifier is identified as dead.

property NotifierDeadEvent: Nullable<TEventId> read GetNotifierDeadEvent

Type: Nullable<TEventId>


NotifierDroppedEvent

Returns the emitted TEventId when a notifier is dropped.

property NotifierDroppedEvent: Nullable<TEventId> read GetNotifierDroppedEvent

Type: Nullable<TEventId>


Method Descriptions

ToString

Returns a string representation of the config.

function ToString: String

Returns

String