Template Class Response

Defined in File response.hpp

Inheritance Relationships

Base Type

public iox::popo::SmartChunk< RpcInterface< Response< T >, ServerSendError >, T, cxx::add_const_conditionally_t< ResponseHeader, T > > (Template Class SmartChunk)

Class Documentation

template<typename T> class Response : public iox::popo::SmartChunk<RpcInterface<Response<T>, ServerSendError>, T, cxx::add_const_conditionally_t<ResponseHeader, T>>

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

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

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)

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

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

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

const ResponseHeader &getResponseHeader() const noexcept

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

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