network_options Class Reference

#include <couchbase/network_options.hxx>

Classes
struct	built

Public Member Functions
auto	preferred_network (std::string network_name) -> network_options &
	Selects network to use.
auto	enable_tcp_keep_alive (bool enable) -> network_options &
auto	tcp_keep_alive_interval (std::chrono::milliseconds interval) -> network_options &
auto	config_poll_interval (std::chrono::milliseconds interval) -> network_options &
auto	idle_http_connection_timeout (std::chrono::milliseconds timeout) -> network_options &
auto	max_http_connections (std::size_t number_of_connections) -> network_options &
auto	force_ip_protocol (ip_protocol protocol) -> network_options &
auto	preferred_server_group (std::string server_group) -> network_options &
	Select server group to use for replica APIs.
auto	enable_lazy_connections (bool enable) -> network_options &
	Enables or disables lazy connection of data endpoints.
auto	build () const -> built

Static Public Attributes
static constexpr std::chrono::milliseconds	default_tcp_keep_alive_interval
static constexpr std::chrono::milliseconds	default_config_poll_interval { 2'500 }
static constexpr std::chrono::milliseconds	default_config_poll_floor { 50 }
static constexpr std::chrono::milliseconds	default_idle_http_connection_timeout { 4'500 }

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

config_poll_interval()

auto config_poll_interval ( std::chrono::milliseconds interval ) -> network_options &

inline

enable_lazy_connections()

auto enable_lazy_connections ( bool enable ) -> network_options &

inline

Enables or disables lazy connection of data endpoints.

When enabled, connections are established only when the first operation for a given endpoint is scheduled, rather than at cluster object construction time.

Volatile

Should not be used in production This option is considered unstable and may change in future releases.

Since

1.3.0

enable_tcp_keep_alive()

auto enable_tcp_keep_alive ( bool enable ) -> network_options &

inline

force_ip_protocol()

auto force_ip_protocol ( ip_protocol protocol ) -> network_options &

inline

idle_http_connection_timeout()

auto idle_http_connection_timeout ( std::chrono::milliseconds timeout ) -> network_options &

inline

max_http_connections()

auto max_http_connections ( std::size_t number_of_connections ) -> network_options &

inline

preferred_network()

auto preferred_network ( std::string network_name ) -> network_options &

inline

Selects network to use.

Parameters

name	network name as it is exposed in the configuration.

Returns

this object for chaining purposes.

See also

https://docs.couchbase.com/server/current/learn/clusters-and-availability/connectivity.html#alternate-addresses

https://docs.couchbase.com/server/current/rest-api/rest-set-up-alternate-address.html

preferred_server_group()

auto preferred_server_group ( std::string server_group ) -> network_options &

inline

Select server group to use for replica APIs.

For some use-cases it might be necessary to restrict list of the nodes, that are used in replica read APIs to single server group to optimize network costs.

See also

read_preference

collection::get_all_replicas

collection::get_any_replica

collection::lookup_in_all_replicas

collection::lookup_in_any_replica

transactions::async_attempt_context::get_replica_from_preferred_server_group

transactions::attempt_context::get_replica_from_preferred_server_group

https://docs.couchbase.com/server/current/manage/manage-groups/manage-groups.html

tcp_keep_alive_interval()

auto tcp_keep_alive_interval ( std::chrono::milliseconds interval ) -> network_options &

inline

Member Data Documentation

default_config_poll_floor

std::chrono::milliseconds default_config_poll_floor { 50 }

staticconstexpr

default_config_poll_interval

std::chrono::milliseconds default_config_poll_interval { 2'500 }

staticconstexpr

default_idle_http_connection_timeout

std::chrono::milliseconds default_idle_http_connection_timeout { 4'500 }

staticconstexpr

default_tcp_keep_alive_interval

std::chrono::milliseconds default_tcp_keep_alive_interval

staticconstexpr

Initial value:

{ std::chrono::seconds{
    60 } }

---

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

• couchbase/network_options.hxx