TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
The TRequestMut represents the object that contains the payload that the client sends to the server.
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 | |
| 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. |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal | |
| NotEqual |
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 reference to the user defined request payload. |
| Send | Sends the TRequestMut to all connected servers of the service. |
Property Descriptions
Handle
property Handle: THandle read GetHandle
Type: THandle
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.
Constructor Descriptions
Assign
constructor Assign(var ADest: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ASrc: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>)
Parameters
ADest: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
ASrc: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TRequestMut, Pointer)
class operator Equal(const ALeft: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
ARight: Pointer
Returns
Boolean
NotEqual(TRequestMut, Pointer)
class operator NotEqual(const ALeft: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>
ARight: Pointer
Returns
Boolean
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 reference to the user defined request payload.
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.
Send
Sends the TRequestMut to all connected servers of the service.
function Send: TResult<TPendingResponse<TReqPayl>, TRequestSendError>; inline
Returns
TResult<TPendingResponse<TReqPayl>, TRequestSendError>