TResponseMutUninit<TRespPayl, TRespUsrHdr>
Acquired by a TActiveRequest with TActiveRequest.LoanUninit.
It stores the payload of the response that will be sent to the corresponding PendingResponse of the client.
If the TResponseMutUninit is not sent it will release the loaned memory when going out of scope.
Definition
Unit: Neslib.Iceoryx2.RequestResponse
Type Parameters
TRespPayl:
TRespUsrHdr:
Nested Types
| Name | Description |
|---|---|
| PResponsePayload | |
| PResponseUserHeader | |
| TResponsePayload | |
| TResponseUserHeader |
Properties
| Name | Description |
|---|---|
| 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. |
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. |
| WriteFromFunction<T> | Writes the provided payload into the TResponseMutUninit and returns an initialized TResponseMut that is ready to be sent. |
| WriteFromSlice<T> | Writes the provided payload into the TResponseMutUninit and returns an initialized TResponseMut that is ready to be sent. |
| WritePayload | Writes the provided payload into the TResponseMutUninit and returns an initialized TResponseMut that is ready to be sent. |
Property Descriptions
Header
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.
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
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
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.
PayloadSliceMut<T>
Returns a mutable slice to the payload slice of the sample.
function PayloadSliceMut<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.
WriteFromFunction<T>(TWriteElementFunc<T>)
Writes the provided payload into the TResponseMutUninit and returns an initialized TResponseMut that is ready to be sent.
function WriteFromFunction<T>(const AFunc: TWriteElementFunc<T>): TResponseMut<TRespPayl, TRespUsrHdr>; inline
Type Parameters
T:
Parameters
AFunc: TWriteElementFunc<T>
Returns
TResponseMut<TRespPayl, TRespUsrHdr>
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.
WriteFromSlice<T>(TSlice<T>)
Writes the provided payload into the TResponseMutUninit and returns an initialized TResponseMut that is ready to be sent.
function WriteFromSlice<T>(const AValue: TSlice<T>): TResponseMut<TRespPayl, TRespUsrHdr>; inline
Type Parameters
T:
Parameters
AValue: TSlice<T>
Returns
TResponseMut<TRespPayl, TRespUsrHdr>
Remarks
Can only be used when TRequestPayload is a slice (TSlice
The type parameter T must be the element type of the slice. E.g. if TRequestPayload = TSlice<word>, then T must be Word. This is checked with an assertion.
WritePayload(TResponsePayload)
Writes the provided payload into the TResponseMutUninit and returns an initialized TResponseMut that is ready to be sent.
function WritePayload(const AValue: TResponsePayload): TResponseMut<TRespPayl, TRespUsrHdr>; inline
Parameters
AValue: TResponsePayload
Returns
TResponseMut<TRespPayl, TRespUsrHdr>
Remarks
Cannot be used when TResponsePayload is a slice (TSlice