Skip to content

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>

Builder to create new TMessagingPattern.RequestResponse based services

Definition

Unit: Neslib.Iceoryx2.RequestResponse

type TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> = record ... end;

Type Parameters

TReqPayl:

TReqUsrHdr:

TRespPayl:

TRespUsrHdr:

Methods

Name Description
_Init
Create Creates a new service.
CreateWithAttributes Creates a new service with a set of attributes.
EnableFireAndForgetRequests If the service is created, defines the fire-and-forget behavior of the service for requests.
EnableSafeOverflowForRequests If the service is created, defines the overflow behavior of the service for requests. If an existing service is opened it requires the service to have the defined overflow behavior.
EnableSafeOverflowForResponses If the service is created, defines the overflow behavior of the service for responses. If an existing service is opened it requires the service to have the defined overflow behavior.
MaxActiveRequestsPerClient Defines how many active requests a TServer can hold in parallel per TClient. The objects are used to send answers to a request that was received earlier from a TClient.
MaxBorrowedResponsesPerPendingResponse If the service is created it defines how many TResponse's shall be able to be borrowed in parallel per TPendingResponse. If an existing service is opened it defines how many borrows must be at least supported.
MaxClients If the service is created it defines how many TClient's shall be supported at most. If an existing service is opened it defines how many TClient's must be at least supported.
MaxLoanedRequests If the service is created it defines how many TRequestMut's a TClient can loan in parallel.
MaxNodes If the service is created it defines how many TNode's shall be able to open it in parallel. If an existing service is opened it defines how many TNode's must be at least supported.
MaxResponseBufferSize If the service is created it defines how many responses fit in the TClients's buffer. If an existing service is opened it defines the minimum required.
MaxServers If the service is created it defines how many TServer's shall be supported at most. If an existing service is opened it defines how many TServer's must be at least supported.
Open Opens an existing service.
OpenOrCreate If the service exists, it will be opened otherwise a new service will be created.
OpenOrCreateWithAttributes If the service exists, it will be opened otherwise a new service will be created. It defines a set of attributes.
OpenWithAttributes Opens an existing service with attribute requirements. If the defined attribute requirements are not satisfied the open process will fail.
RequestPayloadAlignment If the service is created, it defines the request alignment of the payload for the service. If an existing service is opened it requires the service to have at least the defined alignment. If the payload alignment is greater than the provided alignment then the payload alignment is used.
RequestUserHeader<TNewRequestUserHeader> Sets the request user header type of the service.
ResponsePayloadAlignment If the service is created, it defines the response alignment of the payload for the service. If an existing service is opened it requires the service to have at least the defined alignment. If the payload alignment is greater than the provided alignment then the payload alignment is used.
ResponseUserHeader<TNewResponseUserHeader> Sets the response user header type of the servic].
ResumeBuild Returns the builder as an r-value so the fluent chain can be resumed after a free function, such as SetRequestHeaderTypeDetails or SetRequestPayloadTypeDetails, has been applied to the named builder.

Method Descriptions

_Init(_iox2_service_builder_h, TServiceType)

procedure _Init(const AHandle: _iox2_service_builder_h; const AServiceType: TServiceType); inline

Parameters

AHandle: _iox2_service_builder_h

AServiceType: TServiceType


Create

Creates a new service.

function Create: TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseCreateError>; inline

Returns

TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseCreateError>


CreateWithAttributes(TAttributeSpecifier)

Creates a new service with a set of attributes.

function CreateWithAttributes(const AAttributes: TAttributeSpecifier): TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseCreateError>; inline

Parameters

AAttributes: TAttributeSpecifier

Returns

TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseCreateError>


EnableFireAndForgetRequests(Boolean)

If the service is created, defines the fire-and-forget behavior of the service for requests.

function EnableFireAndForgetRequests(const AValue: Boolean): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: Boolean

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


EnableSafeOverflowForRequests(Boolean)

If the service is created, defines the overflow behavior of the service for requests. If an existing service is opened it requires the service to have the defined overflow behavior.

function EnableSafeOverflowForRequests(const AValue: Boolean): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: Boolean

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


EnableSafeOverflowForResponses(Boolean)

If the service is created, defines the overflow behavior of the service for responses. If an existing service is opened it requires the service to have the defined overflow behavior.

function EnableSafeOverflowForResponses(const AValue: Boolean): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: Boolean

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxActiveRequestsPerClient(UInt64)

Defines how many active requests a TServer can hold in parallel per TClient. The objects are used to send answers to a request that was received earlier from a TClient.

function MaxActiveRequestsPerClient(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxBorrowedResponsesPerPendingResponse(UInt64)

If the service is created it defines how many TResponse's shall be able to be borrowed in parallel per TPendingResponse. If an existing service is opened it defines how many borrows must be at least supported.

function MaxBorrowedResponsesPerPendingResponse(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxClients(UInt64)

If the service is created it defines how many TClient's shall be supported at most. If an existing service is opened it defines how many TClient's must be at least supported.

function MaxClients(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxLoanedRequests(UInt64)

If the service is created it defines how many TRequestMut's a TClient can loan in parallel.

function MaxLoanedRequests(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxNodes(UInt64)

If the service is created it defines how many TNode's shall be able to open it in parallel. If an existing service is opened it defines how many TNode's must be at least supported.

function MaxNodes(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxResponseBufferSize(UInt64)

If the service is created it defines how many responses fit in the TClients's buffer. If an existing service is opened it defines the minimum required.

function MaxResponseBufferSize(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


MaxServers(UInt64)

If the service is created it defines how many TServer's shall be supported at most. If an existing service is opened it defines how many TServer's must be at least supported.

function MaxServers(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


Open

Opens an existing service.

function Open: TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenError>; inline

Returns

TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenError>


OpenOrCreate

If the service exists, it will be opened otherwise a new service will be created.

function OpenOrCreate: TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenOrCreateError>; inline

Returns

TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenOrCreateError>


OpenOrCreateWithAttributes(TAttributeVerifier)

If the service exists, it will be opened otherwise a new service will be created. It defines a set of attributes.

If the service already exists all attribute requirements must be satisfied, and service payload type must be the same, otherwise the open process will fail. If the service does not exist the required attributes will be defined in the service.

function OpenOrCreateWithAttributes(const ARequiredAttributes: TAttributeVerifier): TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenOrCreateError>; inline

Parameters

ARequiredAttributes: TAttributeVerifier

Returns

TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenOrCreateError>


OpenWithAttributes(TAttributeVerifier)

Opens an existing service with attribute requirements. If the defined attribute requirements are not satisfied the open process will fail.

function OpenWithAttributes(const ARequiredAttributes: TAttributeVerifier): TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenError>; inline

Parameters

ARequiredAttributes: TAttributeVerifier

Returns

TResult<TPortFactoryRequestResponse<TReqPayl>, TRequestResponseOpenError>


RequestPayloadAlignment(UInt64)

If the service is created, it defines the request alignment of the payload for the service. If an existing service is opened it requires the service to have at least the defined alignment. If the payload alignment is greater than the provided alignment then the payload alignment is used.

function RequestPayloadAlignment(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


RequestUserHeader<TNewRequestUserHeader>

Sets the request user header type of the service.

function RequestUserHeader<TNewRequestUserHeader>: TServiceBuilderRequestResponse<TReqPayl, TNewRequestUserHeader, TRespPayl, TRespUsrHdr>; inline

Type Parameters

TNewRequestUserHeader:

Returns

TServiceBuilderRequestResponse<TReqPayl, TNewRequestUserHeader, TRespPayl, TRespUsrHdr>


ResponsePayloadAlignment(UInt64)

If the service is created, it defines the response alignment of the payload for the service. If an existing service is opened it requires the service to have at least the defined alignment. If the payload alignment is greater than the provided alignment then the payload alignment is used.

function ResponsePayloadAlignment(const AValue: UInt64): TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Parameters

AValue: UInt64

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


ResponseUserHeader<TNewResponseUserHeader>

Sets the response user header type of the servic].

function ResponseUserHeader<TNewResponseUserHeader>: TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TNewResponseUserHeader>; inline

Type Parameters

TNewResponseUserHeader:

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TNewResponseUserHeader>


ResumeBuild

Returns the builder as an r-value so the fluent chain can be resumed after a free function, such as SetRequestHeaderTypeDetails or SetRequestPayloadTypeDetails, has been applied to the named builder.

function ResumeBuild: TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline

Returns

TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>