TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
Sends TRequestMut's to a server in a request-response based communication.
Definition
Unit: Neslib.Iceoryx2.RequestResponse
Type Parameters
TReqPayl:
TReqUsrHdr:
TRespPayl:
TRespUsrHdr:
Nested Types
| Name | Description |
|---|---|
| PRequestPayload | |
| PRequestUserHeader | |
| PResponsePayload | |
| PResponseUserHeader | |
| TRequestPayload | |
| TRequestUserHeader | |
| TResponsePayload | |
| TResponseUserHeader |
Properties
| Name | Description |
|---|---|
| Handle |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
Methods
| Name | Description |
|---|---|
| BackpressureStrategy | Returns the strategy the TClient follows when a TRequestMut cannot be delivered if the TServer's buffer is full. |
| Id | Returns the TUniqueClientId of the TClient |
| InitialMaxSliceLen | Returns the maximum number of elements that can be loaned in a slice. |
| Loan | Acquires the payload for the request and initializes the underlying memory with default. This can be very expensive when the payload is large, therefore prefer TClient.LoanUninit when possible. |
| LoanSlice | Acquires the payload for the request and initializes the underlying memory with default. This can be very expensive when the payload is large, therefore prefer TClient.LoanSliceUninit when possible. |
| LoanSliceUninit | Acquires a TRequestMutUninit to store payload. This API shall be used by default to avoid unnecessary copies. |
| LoanUninit | Acquires a TRequestMutUninit to store payload. This API shall be used by default to avoid unnecessary copies. |
| MaxActiveRequests | Returns the maximal active requests a TClient can send. |
| Name | Returns the TPortNameView of the TClient |
| SendCopy | Copies the input value into a TRequestMut and sends it. On success it returns a TPendingResponse that can be used to receive a stream of responses from the server. |
| SendSliceCopy | Copies the input value into a TRequestMut and sends it. On success it returns a TPendingResponse that can be used to receive a stream of TResponse's from the TServer. |
Property Descriptions
Handle
property Handle: THandle read GetHandle
Type: THandle
Constructor Descriptions
Assign
constructor Assign(var ADest: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ASrc: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>)
Parameters
ADest: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
ASrc: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TClient, Pointer)
class operator Equal(const ALeft: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
ARight: Pointer
Returns
Boolean
NotEqual(TClient, Pointer)
class operator NotEqual(const ALeft: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
ARight: Pointer
Returns
Boolean
Method Descriptions
BackpressureStrategy
Returns the strategy the TClient follows when a TRequestMut cannot be delivered if the TServer's buffer is full.
function BackpressureStrategy: TBackpressureStrategy; inline
Returns
Id
Returns the TUniqueClientId of the TClient
function Id: TUniqueClientId; inline
Returns
InitialMaxSliceLen
Returns the maximum number of elements that can be loaned in a slice.
function InitialMaxSliceLen: Int64; inline
Returns
Int64
Remarks
Can only be used when TRequestPayload is a slice (TSlice
Loan
Acquires the payload for the request and initializes the underlying memory with default. This can be very expensive when the payload is large, therefore prefer TClient.LoanUninit when possible.
function Loan: TResult<TRequestMut<TReqPayl>, TLoanError>
Returns
TResult<TRequestMut<TReqPayl>, TLoanError>
Remarks
Cannot be used when TRequestPayload is a slice (TSlice
LoanSlice(UInt64)
Acquires the payload for the request and initializes the underlying memory with default. This can be very expensive when the payload is large, therefore prefer TClient.LoanSliceUninit when possible.
function LoanSlice(const ANumerOfElements: UInt64): TResult<TRequestMut<TReqPayl>, TLoanError>
Parameters
ANumerOfElements: UInt64
Returns
TResult<TRequestMut<TReqPayl>, TLoanError>
LoanSliceUninit(UInt64)
Acquires a TRequestMutUninit to store payload. This API shall be used by default to avoid unnecessary copies.
function LoanSliceUninit(const ANumerOfElements: UInt64): TResult<TRequestMutUninit<TReqPayl>, TLoanError>; inline
Parameters
ANumerOfElements: UInt64
Returns
TResult<TRequestMutUninit<TReqPayl>, TLoanError>
Remarks
Can only be used when TRequestPayload is a slice (TSlice
LoanUninit
Acquires a TRequestMutUninit to store payload. This API shall be used by default to avoid unnecessary copies.
function LoanUninit: TResult<TRequestMutUninit<TReqPayl>, TLoanError>; inline
Returns
TResult<TRequestMutUninit<TReqPayl>, TLoanError>
Remarks
Cannot be used when TRequestPayload is a slice (TSlice
MaxActiveRequests
Returns the maximal active requests a TClient can send.
function MaxActiveRequests: Int64; inline
Returns
Int64
Name
Returns the TPortNameView of the TClient
function Name: TPortNameView; inline
Returns
SendCopy(TRequestPayload)
Copies the input value into a TRequestMut and sends it. On success it returns a TPendingResponse that can be used to receive a stream of responses from the server.
function SendCopy(const APayload: TRequestPayload): TResult<TPendingResponse<TReqPayl>, TRequestSendError>; inline
Parameters
APayload: TRequestPayload
Returns
TResult<TPendingResponse<TReqPayl>, TRequestSendError>
Remarks
Cannot be used when TRequestPayload is a slice (TSlice
SendSliceCopy(TRequestPayload)
Copies the input value into a TRequestMut and sends it. On success it returns a TPendingResponse that can be used to receive a stream of TResponse's from the TServer.
function SendSliceCopy(const APayload: TRequestPayload): TResult<TPendingResponse<TReqPayl>, TRequestSendError>; inline
Parameters
APayload: TRequestPayload
Returns
TResult<TPendingResponse<TReqPayl>, TRequestSendError>
Remarks
Can only be used when TRequestPayload is a slice (TSlice