Skip to content

TStaticConfigPublishSubscribe

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

Definition

Unit: Neslib.Iceoryx2.PublishSubscribe

type TStaticConfigPublishSubscribe = record ... end;

Properties

Name Description
HasSafeOverflow Returns True if the service safely overflows, otherwise False. Safe overflow means that the TPublisher will recycle the oldest TSample from the TSubscriber when its buffer is full.
HistorySize Returns the maximum history size that can be requested on connect.
MaxNodes Returns the maximum supported amount of TNode's that can open the service in parallel.
MaxPublishers Returns the maximum supported amount of TPublisher ports
MaxSubscribers Returns the maximum supported amount of TSubscriber ports
MessageTypeDetails Returns the type details of the service.
SubscriberMaxBorrowedSamples Returns how many TSample's a TSubscriber port can borrow in parallel at most.
SubscriberMaxBufferSize Returns the maximum supported buffer size for TSubscriber ports

Methods

Name Description
ToString Returns a string representation of the config.

Property Descriptions

HasSafeOverflow

Returns True if the service safely overflows, otherwise False. Safe overflow means that the TPublisher will recycle the oldest TSample from the TSubscriber when its buffer is full.

property HasSafeOverflow: Boolean read FValue.enable_safe_overflow

Type: Boolean


HistorySize

Returns the maximum history size that can be requested on connect.

property HistorySize: NativeInt read FValue.history_size

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


MaxPublishers

Returns the maximum supported amount of TPublisher ports

property MaxPublishers: NativeInt read FValue.max_publishers

Type: NativeInt


MaxSubscribers

Returns the maximum supported amount of TSubscriber ports

property MaxSubscribers: NativeInt read FValue.max_subscribers

Type: NativeInt


MessageTypeDetails

Returns the type details of the service.

property MessageTypeDetails: TMessageTypeDetails read GetMessageTypeDetails

Type: TMessageTypeDetails


SubscriberMaxBorrowedSamples

Returns how many TSample's a TSubscriber port can borrow in parallel at most.

property SubscriberMaxBorrowedSamples: NativeInt read FValue.subscriber_max_borrowed_samples

Type: NativeInt


SubscriberMaxBufferSize

Returns the maximum supported buffer size for TSubscriber ports

property SubscriberMaxBufferSize: NativeInt read FValue.subscriber_max_buffer_size

Type: NativeInt


Method Descriptions

ToString

Returns a string representation of the config.

function ToString: String

Returns

String