Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
common_durability_options< derived_class > Class Template Reference

Common options that used by most operations. More...

#include <couchbase/common_durability_options.hxx>

Inheritance diagram for common_durability_options< derived_class >:
Inheritance graph

Classes

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

Public Member Functions

auto durability (durability_level level) -> derived_class &
 Allows to customize the enhanced durability requirements for this operation.
 
auto durability (persist_to persist_to_nodes, replicate_to replicate_to_nodes) -> derived_class &
 Allows to customize the poll-based durability requirements for this operation.
 
- Public Member Functions inherited from common_options< derived_class >
auto timeout (const std::chrono::milliseconds timeout) -> derived_class &
 Specifies a custom per-operation timeout.
 
auto retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> derived_class &
 Specifies a custom couchbase::retry_strategy for this operation.
 

Protected Member Functions

auto build_common_durability_options () const -> built
 
- Protected Member Functions inherited from common_options< derived_class >
auto build_common_options () const -> built
 
auto self () -> derived_class &
 Allows to return the right options builder instance for child implementations.
 

Detailed Description

template<typename derived_class>
class couchbase::common_durability_options< derived_class >

Common options that used by most operations.

Since
1.0.0
Committed
Generally available API and should be preferred in production

Member Function Documentation

◆ build_common_durability_options()

template<typename derived_class >
auto build_common_durability_options ( ) const -> built
inlinenodiscardprotected
Returns
immutable representation of the common options
Since
1.0.0
Internal
Internal interface

◆ durability() [1/2]

template<typename derived_class >
auto durability ( durability_level level) -> derived_class&
inline

Allows to customize the enhanced durability requirements for this operation.

Note
if a durability(persist_to, replicate_to) has been set beforehand it will be set back to persist_to::none and replicate_to::none, since it is not allowed to use both mechanisms at the same time.
Parameters
levelthe enhanced durability requirement.
Returns
this options builder for chaining purposes.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ durability() [2/2]

template<typename derived_class >
auto durability ( persist_to persist_to_nodes,
replicate_to replicate_to_nodes ) -> derived_class&
inline

Allows to customize the poll-based durability requirements for this operation.

Note
if a durability(durability_level) has been set beforehand it will be set back to durability_level::none, since it is not allowed to use both mechanisms at the same time.
Parameters
persist_to_nodesthe durability persistence requirement.
replicate_to_nodesthe durability replication requirement.
Returns
this options builder for chaining purposes.

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