For streamlined multi-instance operation and interference-free communication, iceoryx2 introduces global configuration settings. It enables the concurrent execution of multiple iceoryx2 setups on the same machine or within a single process by employing distinct configurations.
The configuration is organized into two main sections:
global: Contains settings affecting the entire deployment.defaults: Specifies default settings for quality of services and behaviors.
Adjusting global settings ensures a non-interfering setup.
global.root-path-{unix|windows}- [string]: Defines the path for all iceoryx2 files and directories.global.prefix- [string]: Prefix that is used for every file iceoryx2 creates.
global.node.directory- [string]: Specifies the path for node-related files underglobal.root-path.global.node.monitor-suffix- [string]: Suffix added to the node monitor.global.node.static-config-suffix- [string]: Suffix added to the static config of the node.global.node.service-tag-suffix- [string]: Suffix added to the service tag of the node.global.node.cleanup-dead-nodes-on-creation- [true|false]: Defines if there shall be a scan for dead nodes with a following stale resource cleanup whenever a new node is created.global.node.cleanup-dead-nodes-on-destruction- [true|false]: Defines if there shall be a scan for dead nodes with a following stale resource cleanup whenever a node is going out-of-scope.
global.service.directory- [string]: Specifies the path for service-related files underglobal.root-path.global.service.publisher-data-segment-suffix- [string]: Suffix added to the publisher's data segment.global.service.static-config-storage-suffix- [string]: Suffix for static service configuration files.global.service.dynamic-config-storage-suffix- [string]: Suffix for dynamic service configuration files.global.service.event-connection-suffix- [string]: Suffix for event channel.global.service.connection-suffix- [string]: Suffix for one-to-one connections.global.service.creation-timeout.secs&global.service.creation-timeout.nanos- [int]: Maximum time for service setup. Uncreated services after this are marked as stalled.
defaults.event.max-listeners- [int]: Maximum number of listeners.defaults.event.max-notifiers- [int]: Maximum number of notifiers.defaults.event.max-nodes- [int]: Maximum number of nodes.defaults.event.event-id-max-value- [int]: Greatest value an [EventId] can have.defaults.event.notifier-created-event- [Option<int>]: If defined, it defines the event id that is emitted when a new notifier is created.defaults.event.notifier-dropped-event- [Option<int>]: If defined, it defines the event id that is emitted when a notifier is destroyed.defaults.event.notifier-dead-event- [Option<int>]: If defined, it defines the event id that is emitted when a dead notifier is cleaned up.
defaults.publish-subscribe.max-subscribers- [int]: Maximum number of subscribers.defaults.publish-subscribe.max-publishers- [int]: Maximum number of publishers.defaults.publish-subscribe.max-nodes- [int]: Maximum number of nodes.defaults.publish-subscribe.publisher-history-size- [int]: Maximum history size a subscriber can request.defaults.publish-subscribe.subscriber-buffer-size- [int]: Maximum buffer size of a subscriber.defaults.publish-subscribe.subscriber-max-borrowed-samples- [int]: Maximum samples a subscriber can hold.defaults.publish-subscribe.publisher-max-loaned-samples- [int]: Maximum samples a publisher can loan.defaults.publish-subscribe.enable-safe-overflow- [true|false]: Default overflow behavior.defaults.publish-subscribe.unable-to-deliver-strategy- [Block|DiscardSample]: Default strategy for non-overflowing setups when delivery fails.defaults.publish-subscribe.subscriber-expired-connection-buffer- [int]: Expired connection buffer size of the subscriber. Connections to publishers are expired when the publisher disconnected from the service and the connection contains unconsumed samples.