iox2::Response< Service, ResponsePayload, ResponseUserHeader > Class Template Reference

#include <response.hpp>

Public Member Functions
	Response (Response &&rhs) noexcept
auto	operator= (Response &&rhs) noexcept -> Response &
	~Response () noexcept
	Response (const Response &) noexcept=delete
auto	operator= (const Response &) noexcept -> Response &=delete
auto	header () const -> ResponseHeader
	Returns a reference to the [ResponseHeader].
template<typename T = ResponseUserHeader, typename = std::enable_if_t<!std::is_same<void, ResponseUserHeader>::value, T>>
auto	user_header () const -> const T &
	Returns a reference to the user header of the response.
template<typename T = ResponsePayload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, void>>
auto	payload () const -> const T &
	Returns a reference to the payload of the response.
template<typename T = ResponsePayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto	payload () const -> bb::ImmutableSlice< ValueType >
	Returns a reference to the payload of the response.
auto	origin () const -> UniqueServerId

Friends
template<ServiceType , typename , typename , typename , typename >
class	PendingResponse

Detailed Description

template<ServiceType Service, typename ResponsePayload, typename ResponseUserHeader>
class iox2::Response< Service, ResponsePayload, ResponseUserHeader >

It stores the payload and can be received by the [PendingResponse] after a [RequestMut] was sent to a [Server] via the [Client].

Definition at line 28 of file response.hpp.

Constructor & Destructor Documentation

Response() [1/2]

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

iox2::Response< Service, ResponsePayload, ResponseUserHeader >::Response ( Response< Service, ResponsePayload, ResponseUserHeader > &&  rhs )

inlinenoexcept

Definition at line 71 of file response.hpp.

~Response()

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

iox2::Response< Service, ResponsePayload, ResponseUserHeader >::~Response ( )

inlinenoexcept

Definition at line 87 of file response.hpp.

Response() [2/2]

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

iox2::Response< Service, ResponsePayload, ResponseUserHeader >::Response ( const Response< Service, ResponsePayload, ResponseUserHeader > &  )

deletenoexcept

Member Function Documentation

header()

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::header ( ) const -> ResponseHeader

inline

Returns a reference to the [ResponseHeader].

Definition at line 92 of file response.hpp.

Referenced by iox2::Response< Service, ResponsePayload, ResponseUserHeader >::origin().

operator=() [1/2]

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::operator= ( const Response< Service, ResponsePayload, ResponseUserHeader > &  ) -> Response &=delete

deletenoexcept

operator=() [2/2]

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::operator= ( Response< Service, ResponsePayload, ResponseUserHeader > &&  rhs ) -> Response&

inlinenoexcept

Definition at line 76 of file response.hpp.

origin()

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::origin ( ) const -> UniqueServerId

inline

Returns the [UniqueServerId] of the [Server] which sent the [Response].

Definition at line 132 of file response.hpp.

References iox2::Response< Service, ResponsePayload, ResponseUserHeader >::header().

payload() [1/2]

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

template<typename T = ResponsePayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::payload

(

)

const -> bb::ImmutableSlice< ValueType >

Returns a reference to the payload of the response.

payload() [2/2]

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

template<typename T , typename >

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::payload ( ) const -> const T&

inline

Returns a reference to the payload of the response.

Definition at line 108 of file response.hpp.

user_header()

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

template<typename T , typename >

auto iox2::Response< Service, ResponsePayload, ResponseUserHeader >::user_header ( ) const -> const T&

inline

Returns a reference to the user header of the response.

Definition at line 100 of file response.hpp.

Friends And Related Symbol Documentation

PendingResponse

template<ServiceType Service, typename ResponsePayload , typename ResponseUserHeader >

template<ServiceType , typename , typename , typename , typename >

friend class PendingResponse

friend

Definition at line 61 of file response.hpp.

---

The documentation for this class was generated from the following file:

• iox2/response.hpp