TResponse<TRespPayl, TRespUsrHdr>
It stores the payload and can be received by the TPendingResponse after a TRequestMut was sent to a server via the client.
Definition
Unit: Neslib.Iceoryx2.RequestResponse
Type Parameters
TRespPayl:
TRespUsrHdr:
Nested Types
| Name | Description |
|---|---|
| PResponsePayload | |
| PResponseUserHeader | |
| TResponsePayload | |
| TResponseUserHeader |
Properties
| Name | Description |
|---|---|
| Handle | |
| Header | Returns a reference to the iceoryx2 internal TResponseHeader |
| Origin | Returns the TUniqueServerId of the TServer which sent the TResponse. |
| UserHeader | Returns a reference to the user header of the response. |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
Methods
| Name | Description |
|---|---|
| Payload | Returns a reference to the payload of the response. |
| PayloadSlice<T> | Returns a reference to the payload of the response. |
Property Descriptions
Handle
property Handle: THandle read GetHandle
Type: THandle
Header
Returns a reference to the iceoryx2 internal TResponseHeader
property Header: TResponseHeader read GetHeader
Type: TResponseHeader
Origin
Returns the TUniqueServerId of the TServer which sent the TResponse.
property Origin: TUniqueServerId read GetOrigin
Type: TUniqueServerId
UserHeader
Returns a reference to the user header of the response.
property UserHeader: PResponseUserHeader read GetUserHeader
Type: PResponseUserHeader
Remarks
Cannot be used when there is no TResponseUserHeader (that is, when TResponseUserHeader=Void). This is checked with an assertion.
Constructor Descriptions
Assign
constructor Assign(var ADest: TResponse<TRespPayl, TRespUsrHdr>; const ASrc: TResponse<TRespPayl, TRespUsrHdr>)
Parameters
ADest: TResponse<TRespPayl, TRespUsrHdr>
ASrc: TResponse<TRespPayl, TRespUsrHdr>
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TResponse, Pointer)
class operator Equal(const ALeft: TResponse<TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TResponse<TRespPayl, TRespUsrHdr>
ARight: Pointer
Returns
Boolean
NotEqual(TResponse, Pointer)
class operator NotEqual(const ALeft: TResponse<TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TResponse<TRespPayl, TRespUsrHdr>
ARight: Pointer
Returns
Boolean
Method Descriptions
Payload
Returns a reference to the payload of the response.
function Payload: PResponsePayload; inline
Returns
PResponsePayload
Remarks
Cannot be used when TResponsePayload is a slice (TSlice
PayloadSlice<T>
Returns a reference to the payload of the response.
function PayloadSlice<T>: TSlice<T>; inline
Type Parameters
T:
Returns
Remarks
Can only be used when TResponsePayload is a slice (TSlice
The type parameter T must be the element type of the slice. E.g. if TResponsePayload = TSlice<word>, then T must be Word. This is checked with an assertion.