TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
A version of the TRequestMut where the payload is not initialized which allows true zero copy usage.
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 |
|---|---|
| Header | Returns a reference to the iceoryx2 internal TRequestHeader |
| UserHeader | Returns a reference to the user defined request header. |
| UserHeaderMut | Returns a mutable reference to the user defined request header. |
Methods
| Name | Description |
|---|---|
| Payload | Returns a reference to the user defined request payload. |
| PayloadMut | Returns a mutable reference to the user defined request payload. |
| PayloadSlice<T> | Returns a reference to the user defined request payload. |
| PayloadSliceMut<T> | Returns a mutable slice to the payload slice of the sample. |
| WriteFromFunction<T> | Copies the provided payload into the uninitialized request and returns an initialized TRequestMut. |
| WriteFromSlice<T> | Copies the provided payload into the uninitialized request and returns an initialized TRequestMut. |
| WritePayload | Copies the provided payload into the uninitialized request and returns an initialized TRequestMut. |
Property Descriptions
Header
Returns a reference to the iceoryx2 internal TRequestHeader
property Header: TRequestHeader read GetHeader
Type: TRequestHeader
UserHeader
Returns a reference to the user defined request header.
property UserHeader: PRequestUserHeader read GetUserHeader
Type: PRequestUserHeader
Remarks
Cannot be used when there is no TRequestUserHeader (that is, when TRequestUserHeader=Void). This is checked with an assertion.
UserHeaderMut
Returns a mutable reference to the user defined request header.
property UserHeaderMut: PRequestUserHeader read GetUserHeaderMut
Type: PRequestUserHeader
Remarks
Cannot be used when there is no TRequestUserHeader (that is, when TRequestUserHeader=Void). This is checked with an assertion.
Method Descriptions
Payload
Returns a reference to the user defined request payload.
function Payload: PRequestPayload; inline
Returns
PRequestPayload
Remarks
Cannot be used when TRequestPayload is a slice (TSlice
PayloadMut
Returns a mutable reference to the user defined request payload.
function PayloadMut: PRequestPayload; inline
Returns
PRequestPayload
Remarks
Cannot be used when TRequestPayload is a slice (TSlice
PayloadSlice<T>
Returns a reference to the user defined request payload.
function PayloadSlice<T>: TSlice<T>; inline
Type Parameters
T:
Returns
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.
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 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.
WriteFromFunction<T>(TWriteElementFunc<T>)
Copies the provided payload into the uninitialized request and returns an initialized TRequestMut.
function WriteFromFunction<T>(const AFunc: TWriteElementFunc<T>): TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline
Type Parameters
T:
Parameters
AFunc: TWriteElementFunc<T>
Returns
TRequestMut<TReqPayl, TReqUsrHdr, 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.
WriteFromSlice<T>(TSlice<T>)
Copies the provided payload into the uninitialized request and returns an initialized TRequestMut.
function WriteFromSlice<T>(const AValue: TSlice<T>): TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline
Type Parameters
T:
Parameters
AValue: TSlice<T>
Returns
TRequestMut<TReqPayl, TReqUsrHdr, 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(TRequestPayload)
Copies the provided payload into the uninitialized request and returns an initialized TRequestMut.
function WritePayload(const AValue: TRequestPayload): TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; inline
Parameters
AValue: TRequestPayload
Returns
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
Remarks
Cannot be used when TRequestPayload is a slice (TSlice