iox2::config::RequestResponse Class Reference

#include <config.hpp>

Public Member Functions
auto	enable_safe_overflow_for_requests () &&-> bool
	Defines if the request buffer of the [Service] safely overflows.
void	set_enable_safe_overflow_for_requests (bool value) &&
	Enables/disables safe overflow for the request buffer.
auto	enable_safe_overflow_for_responses () &&-> bool
	Defines if the response buffer of the [Service] safely overflows.
void	set_enable_safe_overflow_for_responses (bool value) &&
	Enables/disables safe overflow for the response buffer.
auto	max_active_requests_per_client () &&-> size_t
void	set_max_active_requests_per_client (size_t value) &&
auto	max_response_buffer_size () &&-> size_t
void	set_max_response_buffer_size (size_t value) &&
auto	max_servers () &&-> size_t
	The maximum amount of supported [crate::port::server::Server].
void	set_max_servers (size_t value) &&
	Set the maximum amount of supported [crate::port::server::Server].
auto	max_clients () &&-> size_t
	The maximum amount of supported [crate::port::client::Client].
void	set_max_clients (size_t value) &&
	Set the maximum amount of supported [crate::port::client::Client].
auto	max_nodes () &&-> size_t
void	set_max_nodes (size_t value) &&
auto	max_borrowed_responses_per_pending_response () &&-> size_t
void	set_max_borrowed_responses_per_pending_response (size_t value) &&
auto	max_loaned_requests () &&-> size_t
void	set_max_loaned_requests (size_t value) &&
auto	server_max_loaned_responses_per_request () &&-> size_t
void	set_server_max_loaned_responses_per_request (size_t value) &&
auto	client_backpressure_strategy () &&-> BackpressureStrategy
void	set_client_backpressure_strategy (BackpressureStrategy value) &&
auto	server_backpressure_strategy () &&-> BackpressureStrategy
void	set_server_backpressure_strategy (BackpressureStrategy value) &&
auto	client_expired_connection_buffer () &&-> size_t
void	set_client_expired_connection_buffer (size_t value) &&
auto	server_expired_connection_buffer () &&-> size_t
void	set_server_expired_connection_buffer (size_t value) &&
auto	enable_fire_and_forget_requests () &&-> bool
void	set_enable_fire_and_forget_requests (bool value) &&
	Set if fire-and-forget feature is enabled.

Friends
class	Defaults

Detailed Description

Default settings for the request response messaging pattern. These settings are used unless the user specifies custom QoS or port settings.

Definition at line 259 of file config.hpp.

Member Function Documentation

client_backpressure_strategy()

auto iox2::config::RequestResponse::client_backpressure_strategy

(

)

&& -> BackpressureStrategy

Defines the [BackpressureStrategy] when a [Client](crate::port::client::Client) could not deliver the request to the [Server](crate::port::server::Server).

client_expired_connection_buffer()

auto iox2::config::RequestResponse::client_expired_connection_buffer

(

)

&& -> size_t

Defines the size of the internal [Client](crate::port::client::Client) buffer that contains expired connections. An connection is expired when the [Server](crate::port::server::Server) disconnected from a service and the connection still contains unconsumed [Response](crate::response::Response)s.

enable_fire_and_forget_requests()

auto iox2::config::RequestResponse::enable_fire_and_forget_requests

(

)

&& -> bool

Allows the [Server](crate::port::server::Server) to receive [RequestMut](crate::response_mut::ResponseMut)s of [Client](crate::port::client::Client)s that are not interested in a [Response](crate::response::Response), meaning that the [Server](crate::port::server::Server) will receive the [RequestMut](crate::response_mut::ResponseMut) despite the corresponding [PendingResponse](crate::pending_response::PendingResponse) already went out-of-scope. So any [Response](crate::response::Response) sent by the [Server](crate::port::server::Server) would not be received by the corresponding [Client](crate::port::client::Client)s [PendingResponse](crate::pending_response::PendingResponse).

Consider enabling this feature if you do not want to loose any [RequestMut](crate::response_mut::ResponseMut).

enable_safe_overflow_for_requests()

auto iox2::config::RequestResponse::enable_safe_overflow_for_requests

(

)

&& -> bool

Defines if the request buffer of the [Service] safely overflows.

enable_safe_overflow_for_responses()

auto iox2::config::RequestResponse::enable_safe_overflow_for_responses

(

)

&& -> bool

Defines if the response buffer of the [Service] safely overflows.

max_active_requests_per_client()

auto iox2::config::RequestResponse::max_active_requests_per_client

(

)

&& -> size_t

The maximum of [crate::active_request::ActiveRequest]s a [crate::port::server::Server] can hold in parallel per [crate::port::client::Client].

max_borrowed_responses_per_pending_response()

auto iox2::config::RequestResponse::max_borrowed_responses_per_pending_response

(

)

&& -> size_t

The maximum amount of borrowed [crate::response::Response] per [crate::pending_response::PendingResponse] on the [crate::port::client::Client] side.

max_clients()

auto iox2::config::RequestResponse::max_clients

(

)

&& -> size_t

The maximum amount of supported [crate::port::client::Client].

max_loaned_requests()

auto iox2::config::RequestResponse::max_loaned_requests

(

)

&& -> size_t

Defines how many [crate::request_mut::RequestMut] a [crate::port::client::Client] can loan in parallel.

max_nodes()

auto iox2::config::RequestResponse::max_nodes

(

)

&& -> size_t

The maximum amount of supported [crate::node::Node]s. Defines indirectly how many processes can open the service at the same time.

max_response_buffer_size()

auto iox2::config::RequestResponse::max_response_buffer_size

(

)

&& -> size_t

The maximum buffer size for [crate::response::Response]s for a [crate::pending_response::PendingResponse].

max_servers()

auto iox2::config::RequestResponse::max_servers

(

)

&& -> size_t

The maximum amount of supported [crate::port::server::Server].

server_backpressure_strategy()

auto iox2::config::RequestResponse::server_backpressure_strategy

(

)

&& -> BackpressureStrategy

Defines the [BackpressureStrategy] when a [Server](crate::port::server::Server) could not deliver the response to the [Client](crate::port::client::Client).

server_expired_connection_buffer()

auto iox2::config::RequestResponse::server_expired_connection_buffer

(

)

&& -> size_t

Defines the size of the internal [Server] buffer that contains expired connections. An connection is expired when the [Client] disconnected from a service and the connection still contains unconsumed [ActiveRequest]s.

server_max_loaned_responses_per_request()

auto iox2::config::RequestResponse::server_max_loaned_responses_per_request

(

)

&& -> size_t

Defines how many [crate::response_mut::ResponseMut] a [crate::port::server::Server] can loan in parallel per [crate::active_request::ActiveRequest].

set_client_backpressure_strategy()

void iox2::config::RequestResponse::set_client_backpressure_strategy

(

BackpressureStrategy

value

)

&&

Set the [BackpressureStrategy] when a [Client](crate::port::client::Client) could not deliver the request to the [Server](crate::port::server::Server).

set_client_expired_connection_buffer()

void iox2::config::RequestResponse::set_client_expired_connection_buffer

(

size_t

value

)

&&

Set the size of the internal [Client](crate::port::client::Client) buffer that contains expired connections. An connection is expired when the [Server](crate::port::server::Server) disconnected from a service and the connection still contains unconsumed [Response](crate::response::Response)s.

set_enable_fire_and_forget_requests()

void iox2::config::RequestResponse::set_enable_fire_and_forget_requests

(

bool

value

)

&&

Set if fire-and-forget feature is enabled.

set_enable_safe_overflow_for_requests()

void iox2::config::RequestResponse::set_enable_safe_overflow_for_requests

(

bool

value

)

&&

Enables/disables safe overflow for the request buffer.

set_enable_safe_overflow_for_responses()

void iox2::config::RequestResponse::set_enable_safe_overflow_for_responses

(

bool

value

)

&&

Enables/disables safe overflow for the response buffer.

set_max_active_requests_per_client()

void iox2::config::RequestResponse::set_max_active_requests_per_client

(

size_t

value

)

&&

Set the maximum of [crate::active_request::ActiveRequest]s a [crate::port::server::Server] can hold in parallel per [crate::port::client::Client].

set_max_borrowed_responses_per_pending_response()

void iox2::config::RequestResponse::set_max_borrowed_responses_per_pending_response

(

size_t

value

)

&&

Set the maximum amount of borrowed [crate::response::Response] per [crate::pending_response::PendingResponse] on the [crate::port::client::Client] side.

set_max_clients()

void iox2::config::RequestResponse::set_max_clients

(

size_t

value

)

&&

Set the maximum amount of supported [crate::port::client::Client].

set_max_loaned_requests()

void iox2::config::RequestResponse::set_max_loaned_requests

(

size_t

value

)

&&

Set how many [crate::request_mut::RequestMut] a [crate::port::client::Client] can loan in parallel.

set_max_nodes()

void iox2::config::RequestResponse::set_max_nodes

(

size_t

value

)

&&

Set the maximum amount of supported [crate::node::Node]s. Defines indirectly how many processes can open the service at the same time.

set_max_response_buffer_size()

void iox2::config::RequestResponse::set_max_response_buffer_size

(

size_t

value

)

&&

Set the maximum buffer size for [crate::response::Response]s for a [crate::pending_response::PendingResponse].

set_max_servers()

void iox2::config::RequestResponse::set_max_servers

(

size_t

value

)

&&

Set the maximum amount of supported [crate::port::server::Server].

set_server_backpressure_strategy()

void iox2::config::RequestResponse::set_server_backpressure_strategy

(

BackpressureStrategy

value

)

&&

Set the [BackpressureStrategy] when a [Server](crate::port::server::Server) could not deliver the response to the [Client](crate::port::client::Client).

set_server_expired_connection_buffer()

void iox2::config::RequestResponse::set_server_expired_connection_buffer

(

size_t

value

)

&&

Set the size of the internal [Server] buffer that contains expired connections. An connection is expired when the [Client] disconnected from a service and the connection still contains unconsumed [ActiveRequest]s.

set_server_max_loaned_responses_per_request()

void iox2::config::RequestResponse::set_server_max_loaned_responses_per_request

(

size_t

value

)

&&

Set how many [crate::response_mut::ResponseMut] a [crate::port::server::Server] can loan in parallel per [crate::active_request::ActiveRequest].

Friends And Related Symbol Documentation

Defaults

friend class Defaults

friend

Definition at line 368 of file config.hpp.

---

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

• iox2/config.hpp