Inheritance diagram for ping_options:

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

Public Member Functions
auto	report_id (std::string report_id) -> ping_options &
	Sets a custom report ID that will be used in the report.

auto	service_types (std::set< service_type > service_types) -> ping_options &
	Customizes the set of services to ping.

auto	build () const -> built
	Validates the options and returns them as an immutable value.

Public Member Functions inherited from common_options< ping_options >
auto	timeout (const std::chrono::milliseconds timeout) -> ping_options &
	Specifies a custom per-operation timeout.

auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> ping_options &
	Specifies a custom `couchbase::retry_strategy` for this operation.

Additional Inherited Members
Protected Member Functions inherited from common_options< ping_options >
auto	build_common_options () const -> built

auto	self () -> ping_options &
	Allows to return the right options builder instance for child implementations.

Member Function Documentation

◆ build()

auto build ( ) const -> built

inline

Validates the options and returns them as an immutable value.

Exceptions

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

auto report_id ( std::string report_id ) -> ping_options&

inline

Sets a custom report ID that will be used in the report.

If no report ID is provided, the client will generate a unique one.

Parameters

report_id the report ID that should be used.

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

inline

Customizes the set of services to ping.

Parameters

service_types the services to ping.

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