Template Class Request

Defined in File request.hpp

Inheritance Relationships

Base Type

public iox::popo::SmartChunk< RpcInterface< Request< T >, ClientSendError >, T, cxx::add_const_conditionally_t< RequestHeader, T > > (Template Class SmartChunk)

Class Documentation

template<typename T> class Request : public iox::popo::SmartChunk<RpcInterface<Request<T>, ClientSendError>, T, cxx::add_const_conditionally_t<RequestHeader, T>>

The Request class is a mutable abstraction over types which are written to loaned shared memory. These requests are sent to the server via the iceoryx system.

Public Functions

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

Sends the request via the client from which it was loaned and automatically release ownership to it.

Only available for client (non-const type T)

cxx::add_const_conditionally_t<RequestHeader, T> &getRequestHeader() noexcept

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

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

const RequestHeader &getRequestHeader() const noexcept

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

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