Skip to content

TResponseMut<TRespPayl, TRespUsrHdr>

Acquired by a TActiveRequest with TActiveRequest.Loan.

It stores the payload of the response that will be sent to the corresponding PendingResponse of the client.

If the TResponseMut is not sent it will release the loaned memory when going out of scope.

Definition

Unit: Neslib.Iceoryx2.RequestResponse

type TResponseMut<TRespPayl, TRespUsrHdr> = record ... end;

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
UserHeader Returns a reference to the user header of the response.
UserHeaderMut Returns a mutable 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.
PayloadMut Returns a mutable reference to the payload of the response.
PayloadSlice<T> Returns a reference to the payload of the response.
PayloadSliceMut<T> Returns a mutable slice to the payload slice of the sample.
Send Sends a TResponseMut to the corresponding PendingResponse of the Client.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


Returns a reference to the iceoryx2 internal TResponseHeader

property Header: TResponseHeader read GetHeader

Type: TResponseHeader


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.


UserHeaderMut

Returns a mutable reference to the user header of the response.

property UserHeaderMut: PResponseUserHeader read GetUserHeaderMut

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: TResponseMut<TRespPayl, TRespUsrHdr>; const ASrc: TResponseMut<TRespPayl, TRespUsrHdr>)

Parameters

ADest: TResponseMut<TRespPayl, TRespUsrHdr>

ASrc: TResponseMut<TRespPayl, TRespUsrHdr>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TResponseMut, Pointer)

class operator Equal(const ALeft: TResponseMut<TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TResponseMut<TRespPayl, TRespUsrHdr>

ARight: Pointer

Returns

Boolean


NotEqual(TResponseMut, Pointer)

class operator NotEqual(const ALeft: TResponseMut<TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TResponseMut<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). This is checked with an assertion. Otherwise use PayloadSlice instead.


PayloadMut

Returns a mutable reference to the payload of the response.

function PayloadMut: PResponsePayload; inline

Returns

PResponsePayload

Remarks

Cannot be used when TResponsePayload is a slice (TSlice). This is checked with an assertion. Otherwise use PayloadSliceMut instead.


PayloadSlice<T>

Returns a reference to the payload of the response.

function PayloadSlice<T>: TSlice<T>; inline

Type Parameters

T:

Returns

TSlice<T>

Remarks

Can only be used when TResponsePayload is a slice (TSlice). This is checked with an assertion. Otherwise use PayloadMut instead

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.


PayloadSliceMut<T>

Returns a mutable slice to the payload slice of the sample.

function PayloadSliceMut<T>: TSlice<T>; inline

Type Parameters

T:

Returns

TSlice<T>

Remarks

Can only be used when TResponsePayload is a slice (TSlice). This is checked with an assertion. Otherwise use PayloadMut instead

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.


Send

Sends a TResponseMut to the corresponding PendingResponse of the Client.

function Send: TResult<Void, TSendError>; inline

Returns

TResult<Void, TSendError>