TConfig.TRequestResponse
Default settings for the request response messaging pattern. These settings are used unless the user specifies custom QoS or port settings.
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| ClientBackpressureStrategy | Defines the TBackpressureStrategy when a TClient could not deliver the request to the TServer. |
| ClientExpiredConnectionBuffer | Defines the size of the internal TClient buffer that contains expired connections. A connection is expired when the TServer disconnected from a service and the connection still contains unconsumed TResponse's. |
| EnableFireAndForgetRequests | Allows the TServer to receive TRequestMut's of TClient's that are not interested in a TResponse, meaning that the TServer will receive the TRequestMut despite the corresponding TPendingResponse already went out-of-scope. So any TResponse sent by the TServer would not be received by the corresponding TClient's TPendingResponse. |
| EnableSafeOverflowForRequests | Defines if the request buffer of the service safely overflows. |
| EnableSafeOverflowForResponses | Defines if the response buffer of the service safely overflows. |
| MaxActiveRequestsPerClient | The maximum of TActiveRequest's a TServer can hold in parallel per TClient. |
| MaxBorrowedResponsesPerPendingResponse | The maximum amount of borrowed TResponse's per TPendingResponse on the TClient side. |
| MaxClients | The maximum amount of supported TClient's. |
| MaxLoanedRequests | Defines how many TRequestMut's a TClient can loan in parallel. |
| MaxNodes | The maximum amount of supported TNode's. Defines indirectly how many processes can open the service at the same time. |
| MaxResponseBufferSize | The maximum buffer size for TResponse's for a TPendingResponse. |
| MaxServers | The maximum amount of supported TServer's. |
| ServerBackpressureStrategy | Defines the TBackpressureStrategy when a TServer could not deliver the response to the TClient. |
| ServerExpiredConnectionBuffer | Defines the size of the internal TServer buffer that contains expired connections. A connection is expired when the TClient disconnected from a service and the connection still contains unconsumed TActiveRequest's. |
| ServerMaxLoanedResponsesPerRequest | Defines how many TResponseMut's a TServer can loan in parallel per TActiveRequest. |
Property Descriptions
ClientBackpressureStrategy
Defines the TBackpressureStrategy when a TClient could not deliver the request to the TServer.
property ClientBackpressureStrategy: TBackpressureStrategy read GetClientBackpressureStrategy write SetClientBackpressureStrategy
Type: TBackpressureStrategy
ClientExpiredConnectionBuffer
Defines the size of the internal TClient buffer that contains expired connections. A connection is expired when the TServer disconnected from a service and the connection still contains unconsumed TResponse's.
property ClientExpiredConnectionBuffer: NativeInt read GetClientExpiredConnectionBuffer write SetClientExpiredConnectionBuffer
Type: NativeInt
EnableFireAndForgetRequests
Allows the TServer to receive TRequestMut's of TClient's that are not interested in a TResponse, meaning that the TServer will receive the TRequestMut despite the corresponding TPendingResponse already went out-of-scope. So any TResponse sent by the TServer would not be received by the corresponding TClient's TPendingResponse.
Consider enabling this feature if you do not want to loose any TRequestMut.
property EnableFireAndForgetRequests: Boolean read GetEnableFireAndForgetRequests write SetEnableFireAndForgetRequests
Type: Boolean
EnableSafeOverflowForRequests
Defines if the request buffer of the service safely overflows.
property EnableSafeOverflowForRequests: Boolean read GetEnableSafeOverflowForRequests write SetEnableSafeOverflowForRequests
Type: Boolean
EnableSafeOverflowForResponses
Defines if the response buffer of the service safely overflows.
property EnableSafeOverflowForResponses: Boolean read GetEnableSafeOverflowForResponses write SetEnableSafeOverflowForResponses
Type: Boolean
MaxActiveRequestsPerClient
The maximum of TActiveRequest's a TServer can hold in parallel per TClient.
property MaxActiveRequestsPerClient: NativeInt read GetMaxActiveRequestsPerClient write SetMaxActiveRequestsPerClient
Type: NativeInt
MaxBorrowedResponsesPerPendingResponse
The maximum amount of borrowed TResponse's per TPendingResponse on the TClient side.
property MaxBorrowedResponsesPerPendingResponse: NativeInt read GetMaxBorrowedResponsesPerPendingResponse write SetMaxBorrowedResponsesPerPendingResponse
Type: NativeInt
MaxClients
The maximum amount of supported TClient's.
property MaxClients: NativeInt read GetMaxClients write SetMaxClients
Type: NativeInt
MaxLoanedRequests
Defines how many TRequestMut's a TClient can loan in parallel.
property MaxLoanedRequests: NativeInt read GetMaxLoanedRequests write SetMaxLoanedRequests
Type: NativeInt
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
MaxResponseBufferSize
The maximum buffer size for TResponse's for a TPendingResponse.
property MaxResponseBufferSize: NativeInt read GetMaxResponseBufferSize write SetMaxResponseBufferSize
Type: NativeInt
MaxServers
The maximum amount of supported TServer's.
property MaxServers: NativeInt read GetMaxServers write SetMaxServers
Type: NativeInt
ServerBackpressureStrategy
Defines the TBackpressureStrategy when a TServer could not deliver the response to the TClient.
property ServerBackpressureStrategy: TBackpressureStrategy read GetServerBackpressureStrategy write SetServerBackpressureStrategy
Type: TBackpressureStrategy
ServerExpiredConnectionBuffer
Defines the size of the internal TServer buffer that contains expired connections. A connection is expired when the TClient disconnected from a service and the connection still contains unconsumed TActiveRequest's.
property ServerExpiredConnectionBuffer: NativeInt read GetServerExpiredConnectionBuffer write SetServerExpiredConnectionBuffer
Type: NativeInt
ServerMaxLoanedResponsesPerRequest
Defines how many TResponseMut's a TServer can loan in parallel per TActiveRequest.
property ServerMaxLoanedResponsesPerRequest: NativeInt read GetServerMaxLoanedResponsesPerRequest write SetServerMaxLoanedResponsesPerRequest
Type: NativeInt