wait_until_ready_options Struct Reference

Options for wait_until_ready() and wait_until_ready(). More...

#include <couchbase/wait_until_ready_options.hxx>

Classes
struct	built
	Immutable value object representing consistent options. More...

Public Member Functions
auto	desired_state (cluster_state desired_state) -> wait_until_ready_options &
	Sets the state the cluster (or bucket) has to reach before the wait completes.
auto	service_types (std::set< service_type > service_types) -> wait_until_ready_options &
	Customizes the set of services to consider.
auto	build () const -> built
	Validates the options and returns them as an immutable value.

Detailed Description

Options for wait_until_ready() and wait_until_ready().

Since

1.4.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

Validates the options and returns them as an immutable value.

Returns

consistent options as an immutable value

Exceptions

std::system_error

with code errc::common::invalid_argument if the options are not valid

Since

1.4.0

Internal

Internal interface

desired_state()

auto desired_state ( cluster_state desired_state ) -> wait_until_ready_options &

inline

Sets the state the cluster (or bucket) has to reach before the wait completes.

Note

cluster_state::offline is not a valid target and is rejected with errc::common::invalid_argument.

Parameters

desired_state

the target state.

Returns

reference to this object, for use in chaining.

Since

1.4.0

Committed

Generally available API and should be preferred in production

service_types()

auto service_types ( std::set< service_type > service_types ) -> wait_until_ready_options &

inline

Customizes the set of services to consider.

When empty, whichever services the topology reports are considered.

Parameters

service_types

the services to consider.

Returns

reference to this object, for use in chaining.

Since

1.4.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/wait_until_ready_options.hxx