Skip to content

Neslib.Iceoryx2.RequestResponse

Classes & Records

Name Description
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Represents a one-to-one connection to a client holding the corresponding PendingResponse that is coupled with the TRequestMut the client sent to the server. The server will use it to send arbitrary many responses.
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TActiveRequest<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Sends TRequestMut's to a server in a request-response based communication.
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TClientDetailsView Contains the communication settings of the connected TClient.
TDynamicConfigRequestResponse The dynamic configuration of a TMessagingPattern.RequestResponse based service. Contains dynamic parameters like the connected endpoints etc.
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Represents an active connection to all servers that received the TRequestMut. The client can use it to receive the corresponding Responses.
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TPendingResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Factory to create a new client port/endpoint for TMessagingPattern.RequestResponse based communication.
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TPortFactoryClient<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> The factory for TMessagingPattern.PublishSubscribe. It can acquire dynamic and static service information and create Publisher or Subscriber ports.
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TPortFactoryRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Factory to create a new server port/endpoint for TMessagingPattern.RequestResponse based communication.
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TPortFactoryServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TRequestHeader Request header used by TMessagingPattern.RequestResponse
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> The TRequestMut represents the object that contains the payload that the client sends to the server.
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TRequestMut<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> A version of the TRequestMut where the payload is not initialized which allows true zero copy usage.
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TRequestMutUninit<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TResponse<TRespPayl, TRespUsrHdr> It stores the payload and can be received by the TPendingResponse after a TRequestMut was sent to a server via the client.
TResponse<TRespPayl, TRespUsrHdr>.PResponsePayload
TResponse<TRespPayl, TRespUsrHdr>.PResponseUserHeader
TResponse<TRespPayl, TRespUsrHdr>.TResponsePayload
TResponse<TRespPayl, TRespUsrHdr>.TResponseUserHeader
TResponseHeader
TResponseMut<TRespPayl, TRespUsrHdr> Acquired by a TActiveRequest with TActiveRequest.Loan.
TResponseMut<TRespPayl, TRespUsrHdr>.PResponsePayload
TResponseMut<TRespPayl, TRespUsrHdr>.PResponseUserHeader
TResponseMut<TRespPayl, TRespUsrHdr>.TResponsePayload
TResponseMut<TRespPayl, TRespUsrHdr>.TResponseUserHeader
TResponseMutUninit<TRespPayl, TRespUsrHdr> Acquired by a TActiveRequest with TActiveRequest.LoanUninit.
TResponseMutUninit<TRespPayl, TRespUsrHdr>.PResponsePayload
TResponseMutUninit<TRespPayl, TRespUsrHdr>.PResponseUserHeader
TResponseMutUninit<TRespPayl, TRespUsrHdr>.TResponsePayload
TResponseMutUninit<TRespPayl, TRespUsrHdr>.TResponseUserHeader
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Receives TRequestMut from a TClient and responds with TResponse by using an TActiveRequest.
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestPayload
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PRequestUserHeader
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponsePayload
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.PResponseUserHeader
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestPayload
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TRequestUserHeader
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponsePayload
TServer<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr>.TResponseUserHeader
TServerDetailsView Contains the communication settings of the connected TServer.
TServiceBuilderRequestResponse<TReqPayl, TReqUsrHdr, TRespPayl, TRespUsrHdr> Builder to create new TMessagingPattern.RequestResponse based services
TStaticConfigRequestResponse The static configuration of a TMessagingPattern.RequestResponse based service. Contains all parameters that do not change during the lifetime of a service.
TUniqueClientId The system-wide unique id of a TClient.
TUniqueServerId The system-wide unique id of a TServer.

Types

Name Description
TClientCreateError Defines a failure that can occur when a client is created with TPortFactoryClient.
TRequestResponseCreateError Errors that can occur when a new TMessagingPattern.RequestResponse service shall be created.
TRequestResponseOpenError Errors that can occur when an existing TMessagingPattern.RequestResponse service shall be opened.
TRequestResponseOpenOrCreateError Errors that can occur when a TMessagingPattern.RequestResponse service shall be created or opened.
TRequestSendError Failure that can be emitted when a TRequestMut is sent.
TServerCreateError Defines a failure that can occur when a TServer is created with TPortFactoryServer.