iox2::StaticConfigRequestResponse Class Reference

#include <static_config_request_response.hpp>

Public Member Functions
auto	request_message_type_details () const -> MessageTypeDetails
	Returns the request type details of the [Service].
auto	response_message_type_details () const -> MessageTypeDetails
	Returns the response type details of the [Service].
auto	has_safe_overflow_for_requests () const -> bool
auto	has_safe_overflow_for_responses () const -> bool
auto	max_borrowed_responses_per_pending_responses () const -> uint64_t
auto	max_active_requests_per_client () const -> uint64_t
	Returns the maximum of active requests a [Server] can hold in parallel per [Client].
auto	max_response_buffer_size () const -> uint64_t
	Returns the maximum buffer size for responses for a [PendingResponse].
auto	max_loaned_requests () const -> uint64_t
	Returns the maximum number of [RequestMut] a [Client] can loan in parallel.
auto	does_support_fire_and_forget_requests () const -> bool
auto	max_servers () const -> uint64_t
	Returns the maximum number of supported [Server] ports for the [Service].
auto	max_clients () const -> uint64_t
	Returns the maximum number of supported [Client] ports for the [Service].
auto	max_nodes () const -> uint64_t
	Returns the maximum number of supported [Node]s for the [Service].

Friends
template<ServiceType , typename , typename , typename , typename >
class	PortFactoryRequestResponse
class	StaticConfig

Detailed Description

The static configuration of an [MessagingPattern::RequestResponse] based service. Contains all parameters that do not change during the lifetime of a [Service].

Definition at line 23 of file static_config_request_response.hpp.

Member Function Documentation

does_support_fire_and_forget_requests()

auto iox2::StaticConfigRequestResponse::does_support_fire_and_forget_requests

(

)

const -> bool

Returns true if fire and forget [RequestMut]s can be sent from the [Client], otherwise false.

has_safe_overflow_for_requests()

auto iox2::StaticConfigRequestResponse::has_safe_overflow_for_requests

(

)

const -> bool

Returns true if the request buffer of the [Service] safely overflows, otherwise false. Safe overflow means that the [Client] will recycle the oldest requests from the [Server] when its buffer is full.

has_safe_overflow_for_responses()

auto iox2::StaticConfigRequestResponse::has_safe_overflow_for_responses

(

)

const -> bool

Returns true if the response buffer of the [Service] safely overflows, otherwise false. Safe overflow means that the [Server] will recycle the oldest responses from the [Client] when its buffer is full.

max_active_requests_per_client()

auto iox2::StaticConfigRequestResponse::max_active_requests_per_client

(

)

const -> uint64_t

Returns the maximum of active requests a [Server] can hold in parallel per [Client].

max_borrowed_responses_per_pending_responses()

auto iox2::StaticConfigRequestResponse::max_borrowed_responses_per_pending_responses

(

)

const -> uint64_t

Returns the maximum number of borrowed [Response]s a [Client] can hold in parallel per [PendingResponse]

max_clients()

auto iox2::StaticConfigRequestResponse::max_clients

(

)

const -> uint64_t

Returns the maximum number of supported [Client] ports for the [Service].

max_loaned_requests()

auto iox2::StaticConfigRequestResponse::max_loaned_requests

(

)

const -> uint64_t

Returns the maximum number of [RequestMut] a [Client] can loan in parallel.

max_nodes()

auto iox2::StaticConfigRequestResponse::max_nodes

(

)

const -> uint64_t

Returns the maximum number of supported [Node]s for the [Service].

max_response_buffer_size()

auto iox2::StaticConfigRequestResponse::max_response_buffer_size

(

)

const -> uint64_t

Returns the maximum buffer size for responses for a [PendingResponse].

max_servers()

auto iox2::StaticConfigRequestResponse::max_servers

(

)

const -> uint64_t

Returns the maximum number of supported [Server] ports for the [Service].

request_message_type_details()

auto iox2::StaticConfigRequestResponse::request_message_type_details

(

)

const -> MessageTypeDetails

Returns the request type details of the [Service].

response_message_type_details()

auto iox2::StaticConfigRequestResponse::response_message_type_details

(

)

const -> MessageTypeDetails

Returns the response type details of the [Service].

Friends And Related Symbol Documentation

PortFactoryRequestResponse

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

friend class PortFactoryRequestResponse

friend

Definition at line 69 of file static_config_request_response.hpp.

StaticConfig

friend class StaticConfig

friend

Definition at line 70 of file static_config_request_response.hpp.

---

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

• iox2/static_config_request_response.hpp