TStaticConfigRequestResponse
The static configuration of a TMessagingPattern.RequestResponse based service. Contains all parameters that do not change during the lifetime of a service.
Definition
Unit: Neslib.Iceoryx2.RequestResponse
Properties
| Name | Description |
|---|---|
| DoesSupportFireAndForgetRequests | Returns True if fire and forget TRequestMut's can be sent from the TClient, otherwise False. |
| HasSafeOverflowForRequests | Returns True if the request buffer of the service safely overflows, otherwise False. Safe overflow means that the TClient will recycle the oldest requests from the TServer when its buffer is full. |
| HasSafeOverflowForResponses | Returns True if the response buffer of the service safely overflows, otherwise False. Safe overflow means that the TServer will recycle the oldest responses from the TClient when its buffer is full. |
| MaxActiveRequestsPerClient | Returns the maximum of active requests a TServer can hold in parallel per TClient. |
| MaxBorrowedResponsesPerPendingResponse | Returns the maximum number of borrowed TResponse's a TClient can hold in parallel per TPendingResponse. |
| MaxClients | Returns the maximum number of supported TClient ports for the service. |
| MaxLoanedRequests | Returns the maximum number of TRequestMut a TClient can loan in parallel. |
| MaxNodes | Returns the maximum number of supported TNode's for the service. |
| MaxResponseBufferSize | Returns the maximum buffer size for responses for a TPendingResponse. |
| MaxServers | Returns the maximum number of supported TServer ports for the service. |
| RequestMessageTypeDetails | Returns the request type details of the service. |
| ResponseMessageTypeDetails | Returns the response type details of the service. |
Methods
| Name | Description |
|---|---|
| ToString | Returns a string representation of the config. |
Property Descriptions
DoesSupportFireAndForgetRequests
Returns True if fire and forget TRequestMut's can be sent from the TClient, otherwise False.
property DoesSupportFireAndForgetRequests: Boolean read FValue.enable_fire_and_forget_requests
Type: Boolean
HasSafeOverflowForRequests
Returns True if the request buffer of the service safely overflows, otherwise False. Safe overflow means that the TClient will recycle the oldest requests from the TServer when its buffer is full.
property HasSafeOverflowForRequests: Boolean read FValue.enable_safe_overflow_for_requests
Type: Boolean
HasSafeOverflowForResponses
Returns True if the response buffer of the service safely overflows, otherwise False. Safe overflow means that the TServer will recycle the oldest responses from the TClient when its buffer is full.
property HasSafeOverflowForResponses: Boolean read FValue.enable_safe_overflow_for_responses
Type: Boolean
MaxActiveRequestsPerClient
Returns the maximum of active requests a TServer can hold in parallel per TClient.
property MaxActiveRequestsPerClient: NativeInt read FValue.max_active_requests_per_client
Type: NativeInt
MaxBorrowedResponsesPerPendingResponse
Returns the maximum number of borrowed TResponse's a TClient can hold in parallel per TPendingResponse.
property MaxBorrowedResponsesPerPendingResponse: NativeInt read FValue.max_borrowed_responses_per_pending_response
Type: NativeInt
MaxClients
Returns the maximum number of supported TClient ports for the service.
property MaxClients: NativeInt read FValue.max_clients
Type: NativeInt
MaxLoanedRequests
Returns the maximum number of TRequestMut a TClient can loan in parallel.
property MaxLoanedRequests: NativeInt read FValue.max_loaned_requests
Type: NativeInt
MaxNodes
Returns the maximum number of supported TNode's for the service.
property MaxNodes: NativeInt read FValue.max_nodes
Type: NativeInt
MaxResponseBufferSize
Returns the maximum buffer size for responses for a TPendingResponse.
property MaxResponseBufferSize: NativeInt read FValue.max_response_buffer_size
Type: NativeInt
MaxServers
Returns the maximum number of supported TServer ports for the service.
property MaxServers: NativeInt read FValue.max_servers
Type: NativeInt
RequestMessageTypeDetails
Returns the request type details of the service.
property RequestMessageTypeDetails: TMessageTypeDetails read GetRequestMessageTypeDetails
Type: TMessageTypeDetails
ResponseMessageTypeDetails
Returns the response type details of the service.
property ResponseMessageTypeDetails: TMessageTypeDetails read GetResponseMessageTypeDetails
Type: TMessageTypeDetails
Method Descriptions
ToString
Returns a string representation of the config.
function ToString: String
Returns
String