Sends [RequestMut]s to a [Server] in a request-response based communication. More...

#include <client.hpp>

Public Member Functions
	Client (Client &&rhs) noexcept

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

	~Client () noexcept

	Client (const Client &) noexcept=delete

auto	operator= (const Client &) noexcept -> Client &=delete

auto	id () const -> UniqueClientId
	Returns the [`UniqueClientId`] of the [`Client`].

auto	name () const -> PortNameView
	Returns the [`PortNameView`] of the [`Client`].

auto	backpressure_strategy () const -> BackpressureStrategy

auto	max_active_requests () const -> uint64_t
	Returns the maximal active requests a [`Client`] can send.

template<typename T = RequestPayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto	initial_max_slice_len () const -> uint64_t
	Returns the maximum number of elements that can be loaned in a slice.

template<typename T = RequestPayload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, void>>
auto	send_copy (const RequestPayload &payload) const -> bb::Expected< PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >, RequestSendError >

template<typename T = RequestPayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto	send_slice_copy (bb::ImmutableSlice< ValueType > &payload) const -> bb::Expected< PendingResponse< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >, RequestSendError >

template<typename T = RequestPayload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, void>>
auto	loan_uninit () -> bb::Expected< RequestMutUninit< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >, LoanError >

template<typename T = RequestPayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto	loan_slice_uninit (uint64_t number_of_elements) -> bb::Expected< RequestMutUninit< Service, T, RequestUserHeader, ResponsePayload, ResponseUserHeader >, LoanError >

template<typename T = RequestPayload, typename = std::enable_if_t<!bb::IsSlice<T>::VALUE, void>>
auto	loan () -> bb::Expected< RequestMut< Service, T, RequestUserHeader, ResponsePayload, ResponseUserHeader >, LoanError >

template<typename T = RequestPayload, typename = std::enable_if_t<bb::IsSlice<T>::VALUE, void>>
auto	loan_slice (uint64_t number_of_elements) -> bb::Expected< RequestMut< Service, T, RequestUserHeader, ResponsePayload, ResponseUserHeader >, LoanError >

template<typename T = RequestPayload, typename = std::enable_if_t<has_flatbuffer_marker<T>(), void>>
auto	loan_flatbuffer () -> bb::Expected< RequestMutUninit< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >, LoanError >
	Acquires a [`RequestMutUninit`] with an integrated flatbuffer builder.

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

Detailed Description

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

Sends [RequestMut]s to a [Server] in a request-response based communication.

Definition at line 33 of file client.hpp.

Constructor & Destructor Documentation

◆ Client() [1/2]

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

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

inlinenoexcept

Definition at line 129 of file client.hpp.

◆ ~Client()

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

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

inlinenoexcept

Definition at line 155 of file client.hpp.

◆ Client() [2/2]

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

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

deletenoexcept

Member Function Documentation

◆ backpressure_strategy()

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

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::backpressure_strategy ( ) const -> BackpressureStrategy

inline

Returns the strategy the [Client] follows when a [RequestMut] cannot be delivered if the [Server]s buffer is full.

Definition at line 188 of file client.hpp.

◆ id()

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

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::id ( ) const -> UniqueClientId

inline

Returns the [UniqueClientId] of the [Client].

Definition at line 164 of file client.hpp.

◆ initial_max_slice_len()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::initial_max_slice_len ( ) const -> uint64_t

inline

Returns the maximum number of elements that can be loaned in a slice.

Definition at line 211 of file client.hpp.

◆ loan()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan ( ) -> bb::Expected<RequestMut<Service, T, RequestUserHeader, ResponsePayload, ResponseUserHeader>, LoanError>

inline

Acquires the payload for the request and initializes the underlying memory with default. This can be very expensive when the payload is large, therefore prefer [Client::loan_uninit()] when possible.

Definition at line 315 of file client.hpp.

References iox2::assume_init(), iox2::bb::err(), and iox2::loan_uninit().

◆ loan_flatbuffer()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_flatbuffer ( ) -> bb::Expected< RequestMutUninit<Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader>, LoanError>

inline

Acquires a [RequestMutUninit] with an integrated flatbuffer builder.

Definition at line 377 of file client.hpp.

References iox2::bb::err().

◆ loan_slice()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_slice ( uint64_t number_of_elements ) -> bb::Expected<RequestMut<Service, T, RequestUserHeader, ResponsePayload, ResponseUserHeader>, LoanError>

inline

Acquires the payload for the request and initializes the underlying memory with default. This can be very expensive when the payload is large, therefore prefer [Client::loan_uninit()] when possible.

Definition at line 332 of file client.hpp.

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

◆ loan_slice_uninit()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_slice_uninit ( uint64_t number_of_elements ) -> bb::Expected<RequestMutUninit<Service, T, RequestUserHeader, ResponsePayload, ResponseUserHeader>, LoanError>

inline

Acquires an [RequestMutUninit] to store payload. This API shall be used by default to avoid unnecessary copies.

Definition at line 242 of file client.hpp.

References iox2::bb::err(), and iox2::internal::PlacementDefault< T >::placement_default().

◆ loan_uninit()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::loan_uninit ( ) -> bb::Expected< RequestMutUninit<Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader>, LoanError>

inline

Acquires an [RequestMutUninit] to store payload. This API shall be used by default to avoid unnecessary copies.

Definition at line 222 of file client.hpp.

References iox2::bb::err(), and iox2::internal::PlacementDefault< T >::placement_default().

◆ max_active_requests()

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

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::max_active_requests ( ) const -> uint64_t

inline

Returns the maximal active requests a [Client] can send.

Definition at line 199 of file client.hpp.

◆ name()

template<ServiceType Service, typename RequestPayload , typename RequestHeader , typename ResponsePayload , typename ResponseHeader >

auto iox2::Client< Service, RequestPayload, RequestHeader, ResponsePayload, ResponseHeader >::name ( ) const -> PortNameView

inline

Returns the [PortNameView] of the [Client].

Definition at line 176 of file client.hpp.

References iox2::PortNameView::from_native_ptr().

◆ operator=() [1/2]

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

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

inlinenoexcept

Definition at line 139 of file client.hpp.

◆ operator=() [2/2]

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

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

deletenoexcept

◆ send_copy()

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

template<typename T , typename >

auto iox2::Client< Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader >::send_copy ( const RequestPayload & payload ) const -> bb::Expected< PendingResponse<Service, RequestPayload, RequestUserHeader, ResponsePayload, ResponseUserHeader>, RequestSendError>

inline

Copies the input value into a [RequestMut] and sends it. On success it returns a [PendingResponse] that can be used to receive a stream of [Response]s from the [Server].

Definition at line 261 of file client.hpp.

References iox2::bb::err().

◆ send_slice_copy()

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

template<typename T , typename >

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

inline

Copies the input value into a [RequestMut] and sends it. On success it returns a [PendingResponse] that can be used to receive a stream of [Response]s from the [Server].

Definition at line 286 of file client.hpp.

References iox2::bb::err().

Friends And Related Symbol Documentation

◆ PortFactoryClient

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

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

friend class PortFactoryClient

friend

Definition at line 115 of file client.hpp.

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

iox2/client.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Client() [1/2]

◆ ~Client()

◆ Client() [2/2]

Member Function Documentation

◆ backpressure_strategy()

◆ id()

◆ initial_max_slice_len()

◆ loan()

◆ loan_flatbuffer()

◆ loan_slice()

◆ loan_slice_uninit()

◆ loan_uninit()

◆ max_active_requests()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ send_copy()

◆ send_slice_copy()

Friends And Related Symbol Documentation

◆ PortFactoryClient