iox::popo::Response🔗

The Response class is a mutable abstraction over types which are written to loaned shared memory. These responses are sent to the client via the iceoryx system. More...

#include <iceoryx_posh/popo/response.hpp>

Inherits from SmartChunk< RpcInterface< Response< T >, ServerSendError >, T, cxx::add_const_conditionally_t< ResponseHeader, T > >

Public Functions🔗

	Name
template <typename S =T,typename =ForServerOnly> cxx::expected< ServerSendError >	send() Sends the response via the server from which it was loaned and automatically release ownership to it.
cxx::add_const_conditionally_t< ResponseHeader, T > &	getResponseHeader() Retrieve the response-header of the underlying memory chunk loaned to the sample.
const ResponseHeader &	getResponseHeader() const Retrieve the response-header of the underlying memory chunk loaned to the sample.

Friends🔗

	Name
class	ClientImpl
class	ServerImpl

Detailed Description🔗

template <typename T >
class iox::popo::Response;

The Response class is a mutable abstraction over types which are written to loaned shared memory. These responses are sent to the client via the iceoryx system.

Public Functions Documentation🔗

function send🔗

template <typename S  =T,
typename  =ForServerOnly<S, T>>
cxx::expected< ServerSendError > send()

Sends the response via the server from which it was loaned and automatically release ownership to it.

Only available for server (non-const type T)

function getResponseHeader🔗

cxx::add_const_conditionally_t< ResponseHeader, T > & getResponseHeader()

Retrieve the response-header of the underlying memory chunk loaned to the sample.

Return: The response-header of the underlying memory chunk.

function getResponseHeader🔗

const ResponseHeader & getResponseHeader() const

Retrieve the response-header of the underlying memory chunk loaned to the sample.

Return: The response-header of the underlying memory chunk.

Friends🔗

friend ClientImpl🔗

friend class ClientImpl(
    ClientImpl 
);

friend ServerImpl🔗

friend class ServerImpl(
    ServerImpl 
);

Updated on 2 April 2022 at 16:37:47 CEST