Skip to content

TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>

Receives TRequestMut from a TClient and responds with TResponse by using an TActiveRequest.

Definition

Unit: Neslib.Iceoryx2.RequestResponse

type TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> = record ... end;

Type Parameters

TReqPayl:

TReqUsrHdr:

TRespPayl:

TRespUsrHdr:

Nested Types

Name Description
PRequestPayload
PRequestUserHeader
PResponsePayload
PResponseUserHeader
TRequestPayload
TRequestUserHeader
TResponsePayload
TResponseUserHeader

Properties

Name Description
Handle
HasRequests Returns True if the TServer has TRequestMut's in its buffer.
Id Returns the TUniqueServerId of the TServer
InitialMaxSliceLen Returns the maximum initial slice length configured for this TServer.
Name Returns the TPortNameView of the TServer

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
Receive Receives a TRequestMut that was sent by a client and returns a TActiveRequest which can be used to respond. If no TRequestMut's were received it returns None.

Property Descriptions

Handle

property Handle: THandle read GetHandle

Type: THandle


HasRequests

Returns True if the TServer has TRequestMut's in its buffer.

property HasRequests: TResult<Boolean, TConnectionFailure> read GetHasRequests

Type: TResult<Boolean, TConnectionFailure>


Id

Returns the TUniqueServerId of the TServer

property Id: TUniqueServerId read GetId

Type: TUniqueServerId


InitialMaxSliceLen

Returns the maximum initial slice length configured for this TServer.

property InitialMaxSliceLen: Int64 read GetInitialMaxSliceLen

Type: Int64

Remarks

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


Name

Returns the TPortNameView of the TServer

property Name: TPortNameView read GetName

Type: TPortNameView


Constructor Descriptions

Assign

constructor Assign(var ADest: TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>; const ASrc: TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>)

Parameters

ADest: TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>

ASrc: TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TServer, Pointer)

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

Parameters

ALeft: TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>

ARight: Pointer

Returns

Boolean


NotEqual(TServer, Pointer)

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

Parameters

ALeft: TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>

ARight: Pointer

Returns

Boolean


Method Descriptions

Receive

Receives a TRequestMut that was sent by a client and returns a TActiveRequest which can be used to respond. If no TRequestMut's were received it returns None.

function Receive: TResult<TActiveRequest<TReqPayl>, TReceiveError>

Returns

TResult<TActiveRequest<TReqPayl>, TReceiveError>