Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
ping_options Struct Reference

#include <couchbase/ping_options.hxx>

Inheritance diagram for ping_options:
Inheritance graph

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
inlinenodiscard

Validates the options and returns them as an immutable value.

Returns
consistent options as an immutable value
Exceptions
std::system_errorwith code errc::common::invalid_argument if the options are not valid
Since
1.0.0
Internal
Internal interface

◆ report_id()

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_idthe report ID that should be used.
Returns
reference to this object, for use in chaining.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ service_types()

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

Customizes the set of services to ping.

Parameters
service_typesthe services to ping.
Returns
reference to this object, for use in chaining.

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