#include <pending_response.hpp>

Public Member Functions
	PendingResponse (PendingResponse &&rhs) noexcept

auto	operator= (PendingResponse &&rhs) noexcept -> PendingResponse &

	~PendingResponse () noexcept

	PendingResponse (const PendingResponse &)=delete

auto	operator= (const PendingResponse &) -> PendingResponse &=delete

auto	receive () -> bb::Expected< bb::Optional< Response< Service, ResponsePayload, ResponseUserHeader > >, ReceiveError >

auto	header () const -> RequestHeader

template<typename T = RequestUserHeader, typename = std::enable_if_t<!std::is_same<void, RequestUserHeader>::value, T>>
auto	user_header () const -> const T &

template<typename T = RequestPayload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE && !has_flatbuffer_marker<T>(), void>>
auto	payload () const -> const T &

template<typename T = RequestPayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto	payload () const -> bb::ImmutableSlice< ValueType >

template<typename T = RequestPayload, typename = std::enable_if_t<has_flatbuffer_marker<T>(), void>>
auto	payload_bytes () const -> bb::ImmutableSlice< uint8_t >
	Returns the serialized flatbuffer data as bytes.

template<typename T = RequestPayload, typename = std::enable_if_t<has_flatbuffer_marker<T>(), void>>
auto	payload_root () const -> const typename T::ValueType *
	Returns the root of the flatbuffer.

auto	number_of_server_connections () const -> size_t

auto	has_response () -> bool

auto	is_connected () const -> bool

void	set_disconnect_hint ()

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

template<ServiceType S, typename RequestPayloadT , typename RequestUserHeaderT , typename ResponsePayloadT , typename ResponseUserHeaderT >
auto	send (RequestMut< S, RequestPayloadT, RequestUserHeaderT, ResponsePayloadT, ResponseUserHeaderT > &&request) -> bb::Expected< PendingResponse< S, RequestPayloadT, RequestUserHeaderT, ResponsePayloadT, ResponseUserHeaderT >, RequestSendError >

Detailed Description

template<ServiceType Service, typename RequestPayload, typename RequestUserHeader, typename ResponsePayload, typename ResponseUserHeader>
class iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >

Represents an active connection to all [Server] that received the [RequestMut]. The [Client] can use it to receive the corresponding [Response]s.

As soon as it goes out of scope, the connections are closed and the [Server]s are informed.

Definition at line 41 of file pending_response.hpp.

Constructor & Destructor Documentation

◆ PendingResponse() [1/2]

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::PendingResponse ( PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader > && rhs )

inlinenoexcept

Definition at line 133 of file pending_response.hpp.

◆ ~PendingResponse()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::~PendingResponse ( )

inlinenoexcept

Definition at line 159 of file pending_response.hpp.

◆ PendingResponse() [2/2]

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::PendingResponse ( const PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader > & )

delete

Member Function Documentation

◆ has_response()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::has_response ( ) -> bool

inline

Returns [true] when a [Server] has sent a [Response] otherwise [false].

Definition at line 291 of file pending_response.hpp.

◆ header()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::header ( ) const -> RequestHeader

inline

Returns a reference to the iceoryx2 internal [RequestHeader] of the corresponding [RequestMut]

Definition at line 190 of file pending_response.hpp.

Referenced by iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::payload_bytes().

◆ is_connected()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::is_connected ( ) const -> bool

inline

Returns [true] until the [ActiveRequest] goes out of scope on the [Server]s side indicating that the [Server] will no longer send [Response]s. It also returns [false] when there are no [Server]s.

Definition at line 302 of file pending_response.hpp.

◆ number_of_server_connections()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::number_of_server_connections ( ) const -> size_t

inline

Returns how many [Server]s received the corresponding [RequestMut] initially.

Definition at line 280 of file pending_response.hpp.

◆ operator=() [1/2]

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

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

delete

◆ operator=() [2/2]

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

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

inlinenoexcept

Definition at line 143 of file pending_response.hpp.

◆ payload() [1/2]

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

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

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::payload ( ) const -> bb::ImmutableSlice< ValueType >

Returns a reference to the request payload of the corresponding [RequestMut]

◆ payload() [2/2]

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

template<typename T , typename >

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

inline

Returns a reference to the request payload of the corresponding [RequestMut]

Definition at line 218 of file pending_response.hpp.

◆ payload_bytes()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

template<typename T , typename >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::payload_bytes ( ) const -> bb::ImmutableSlice<uint8_t>

inline

Returns the serialized flatbuffer data as bytes.

Definition at line 250 of file pending_response.hpp.

References iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::header().

Referenced by iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::payload_root().

◆ payload_root()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

template<typename T , typename >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::payload_root ( ) const -> const typename T::ValueType*

inline

Returns the root of the flatbuffer.

Definition at line 269 of file pending_response.hpp.

References iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::payload_bytes().

◆ receive()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

auto iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::receive ( ) -> bb::Expected<bb::Optional<Response<Service, ResponsePayload, ResponseUserHeader>>, ReceiveError>

inline

Receives a [Response] from one of the [Server]s that received the [RequestMut].

Definition at line 169 of file pending_response.hpp.

References iox2::bb::err(), and iox2::bb::NULLOPT.

◆ set_disconnect_hint()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

void iox2::PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::set_disconnect_hint ( )

inline

Marks the connection state that the [Client] wants to gracefully disconnect. When the [Server] reads this, it can send the last [Response] and drop the corresponding [ActiveRequest] to terminate the connection ensuring that no [Response] is lost on the [Client] side.

Definition at line 312 of file pending_response.hpp.

◆ user_header()

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

template<typename T , typename >

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

inline

Returns a reference to the user defined request header of the corresponding [RequestMut]

Definition at line 204 of file pending_response.hpp.

Friends And Related Symbol Documentation

◆ Client

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

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

friend class Client

friend

Definition at line 110 of file pending_response.hpp.

◆ send

template<ServiceType Service, typename RequestPayload , typename RequestUserHeader , typename ResponsePayload , typename ResponseUserHeader >

template<ServiceType S, typename RequestPayloadT , typename RequestUserHeaderT , typename ResponsePayloadT , typename ResponseUserHeaderT >

auto send ( RequestMut< S, RequestPayloadT, RequestUserHeaderT, ResponsePayloadT, ResponseUserHeaderT > && request ) -> bb::Expected< PendingResponse< S, RequestPayloadT, RequestUserHeaderT, ResponsePayloadT, ResponseUserHeaderT >, RequestSendError >

friend

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

iox2/pending_response.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PendingResponse() [1/2]

◆ ~PendingResponse()

◆ PendingResponse() [2/2]

Member Function Documentation

◆ has_response()

◆ header()

◆ is_connected()

◆ number_of_server_connections()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ payload() [1/2]

◆ payload() [2/2]

◆ payload_bytes()

◆ payload_root()

◆ receive()

◆ set_disconnect_hint()

◆ user_header()

Friends And Related Symbol Documentation

◆ Client

◆ send