cluster_options Class Reference

#include <couchbase/cluster_options.hxx>

Classes
struct	built

Public Member Functions
	cluster_options (std::string username, std::string password)
	cluster_options (password_authenticator authenticator)
	cluster_options (certificate_authenticator authenticator)
	cluster_options (jwt_authenticator authenticator)
void	apply_profile (const std::string &profile_name)
	Apply settings profile by name.
auto	compression () -> compression_options &
	Returns compression options.
auto	timeouts () -> timeout_options &
	Returns various timeout options.
auto	dns () -> dns_options &
	Returns options for DNS-SRV bootstrap.
auto	security () -> security_options &
	Returns security options (including TLS).
auto	network () -> network_options &
	Returns network options.
auto	metrics () -> metrics_options &
	Returns metrics and observability options.
auto	tracing () -> tracing_options &
	Returns tracing options.
auto	behavior () -> behavior_options &
	Returns misc options that affects cluster behavior.
auto	transactions () -> transactions::transactions_config &
	Returns the transactions options which effect the transactions behavior.
auto	application_telemetry () -> application_telemetry_options &
	Returns the Application Telemetry options.
auto	default_retry_strategy (std::shared_ptr< retry_strategy > strategy) -> cluster_options &
	Override default retry strategy.
auto	crypto_manager (std::shared_ptr< crypto::manager > crypto_manager) -> cluster_options &
auto	build () const -> built

Detailed Description

Examples

async_game_server.cxx, distributed_mutex.cxx, game_server.cxx, and minimal.cxx.

Constructor & Destructor Documentation

cluster_options() [1/4]

cluster_options ( std::string username, std::string password )

inline

Parameters

username
password

Since

1.0.0

Committed

Generally available API and should be preferred in production

cluster_options() [2/4]

cluster_options ( password_authenticator authenticator )

inlineexplicit

Parameters

authenticator

Since

1.0.0

Committed

Generally available API and should be preferred in production

cluster_options() [3/4]

cluster_options ( certificate_authenticator authenticator )

inlineexplicit

Parameters

authenticator

Since

1.0.0

Committed

Generally available API and should be preferred in production

cluster_options() [4/4]

cluster_options ( jwt_authenticator authenticator )

inlineexplicit

Parameters

authenticator

Since

1.3.0

Uncommitted

Might be changed in the future, and eventually promoted to committed

Member Function Documentation

application_telemetry()

auto application_telemetry ( ) -> application_telemetry_options &

inlinenodiscard

Returns the Application Telemetry options.

Returns

application telemetry options.

Since

1.1.0

Committed

Generally available API and should be preferred in production

apply_profile()

void apply_profile ( const std::string & profile_name )

inline

Apply settings profile by name.

At the moment the only one profile is defined: "wan_development".

Parameters

profile_name

name of the registered profile

See also

configuration_profile_registry

wan_development_configuration_profile

Since

1.0.0

Volatile

Should not be used in production

behavior()

auto behavior ( ) -> behavior_options &

inlinenodiscard

Returns misc options that affects cluster behavior.

Returns

misc options.

Since

1.0.0

Volatile

Should not be used in production

build()

auto build ( ) const -> built

inlinenodiscard

compression()

auto compression ( ) -> compression_options &

inlinenodiscard

Returns compression options.

Returns

compression options

Since

1.0.0

Committed

Generally available API and should be preferred in production

crypto_manager()

auto crypto_manager ( std::shared_ptr< crypto::manager > crypto_manager ) -> cluster_options &

inline

default_retry_strategy()

auto default_retry_strategy ( std::shared_ptr< retry_strategy > strategy ) -> cluster_options &

inline

Override default retry strategy.

Returns

cluster options object for chaining

Since

1.0.0

Committed

Generally available API and should be preferred in production

dns()

auto dns ( ) -> dns_options &

inlinenodiscard

Returns options for DNS-SRV bootstrap.

Returns

DNS options

Since

1.0.0

Committed

Generally available API and should be preferred in production

metrics()

auto metrics ( ) -> metrics_options &

inlinenodiscard

Returns metrics and observability options.

Returns

metrics options

Since

1.0.0

Committed

Generally available API and should be preferred in production

network()

auto network ( ) -> network_options &

inlinenodiscard

Returns network options.

Returns

network options

Since

1.0.0

Committed

Generally available API and should be preferred in production

security()

auto security ( ) -> security_options &

inlinenodiscard

Returns security options (including TLS).

Returns

security options

Since

1.0.0

Committed

Generally available API and should be preferred in production

timeouts()

auto timeouts ( ) -> timeout_options &

inlinenodiscard

Returns various timeout options.

Returns

timeout options

Since

1.0.0

Committed

Generally available API and should be preferred in production

tracing()

auto tracing ( ) -> tracing_options &

inlinenodiscard

Returns tracing options.

Returns

tracing options

Since

1.0.0

Committed

Generally available API and should be preferred in production

transactions()

auto transactions ( ) -> transactions::transactions_config &

inlinenodiscard

Returns the transactions options which effect the transactions behavior.

Returns

transactions configuration.

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/cluster_options.hxx