TConfig.TPublishSubscribe
Default settings for the publish-subscribe messaging pattern. These settings are used unless the user specifies custom QoS or port settings.
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| BackpressureStrategy | If safe overflow is deactivated it defines the deliver strategy of the TPublisher when the TSubscriber's buffer is full. |
| EnableSafeOverflow | Defines how the TSubscriber buffer behaves when it is full. When safe overflow is activated, the TPublisher will replace the oldest TSample with the newest one. |
| MaxNodes | The maximum amount of supported TNode's. Defines indirectly how many processes can open the service at the same time. |
| MaxPublishers | The maximum amount of supported TPublisher's |
| MaxSubscribers | The maximum amount of supported TSubscriber's |
| PublisherHistorySize | The maximum history size a TSubscriber can request from a TPublisher. |
| PublisherMaxLoanedSamples | The maximum amount of TSampleMut's a TPublisher can loan at the same time. |
| SubscriberExpiredConnectionBuffer | Defines the size of the internal TSubscriber buffer that contains expired connections. A connection is expired when the TPublisher disconnected from a service and the connection still contains unconsumed TSample's. |
| SubscriberMaxBorrowedSamples | The maximum amount of TSample's a TSubscriber can hold at the same time. |
| SubscriberMaxBufferSize | The maximum buffer size a TSubscriber can have |
Property Descriptions
BackpressureStrategy
If safe overflow is deactivated it defines the deliver strategy of the TPublisher when the TSubscriber's buffer is full.
property BackpressureStrategy: TBackpressureStrategy read GetBackpressureStrategy write SetBackpressureStrategy
Type: TBackpressureStrategy
EnableSafeOverflow
Defines how the TSubscriber buffer behaves when it is full. When safe overflow is activated, the TPublisher will replace the oldest TSample with the newest one.
property EnableSafeOverflow: Boolean read GetEnableSafeOverflow write SetEnableSafeOverflow
Type: Boolean
MaxNodes
The maximum amount of supported TNode's. Defines indirectly how many processes can open the service at the same time.
property MaxNodes: NativeInt read GetMaxNodes write SetMaxNodes
Type: NativeInt
MaxPublishers
The maximum amount of supported TPublisher's
property MaxPublishers: NativeInt read GetMaxPublishers write SetMaxPublishers
Type: NativeInt
MaxSubscribers
The maximum amount of supported TSubscriber's
property MaxSubscribers: NativeInt read GetMaxSubscribers write SetMaxSubscribers
Type: NativeInt
PublisherHistorySize
The maximum history size a TSubscriber can request from a TPublisher.
property PublisherHistorySize: NativeInt read GetPublisherHistorySize write SetPublisherHistorySize
Type: NativeInt
PublisherMaxLoanedSamples
The maximum amount of TSampleMut's a TPublisher can loan at the same time.
property PublisherMaxLoanedSamples: NativeInt read GetPublisherMaxLoanedSamples write SetPublisherMaxLoanedSamples
Type: NativeInt
SubscriberExpiredConnectionBuffer
Defines the size of the internal TSubscriber buffer that contains expired connections. A connection is expired when the TPublisher disconnected from a service and the connection still contains unconsumed TSample's.
property SubscriberExpiredConnectionBuffer: NativeInt read GetSubscriberExpiredConnectionBuffer write SetSubscriberExpiredConnectionBuffer
Type: NativeInt
SubscriberMaxBorrowedSamples
The maximum amount of TSample's a TSubscriber can hold at the same time.
property SubscriberMaxBorrowedSamples: NativeInt read GetSubscriberMaxBorrowedSamples write SetSubscriberMaxBorrowedSamples
Type: NativeInt
SubscriberMaxBufferSize
The maximum buffer size a TSubscriber can have
property SubscriberMaxBufferSize: NativeInt read GetSubscriberMaxBufferSize write SetSubscriberMaxBufferSize
Type: NativeInt