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

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

#include <couchbase/common_options.hxx>

Inheritance diagram for common_options< derived_class >:
Inheritance graph

Classes

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

Public Member Functions

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_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_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_options()

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

◆ retry_strategy()

template<typename derived_class >
auto retry_strategy ( const std::shared_ptr< retry_strategy > strategy) -> derived_class&
inline

Specifies a custom couchbase::retry_strategy for this operation.

Parameters
strategythe retry strategy to use for this operation.
Returns
this options builder for chaining purposes.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ self()

template<typename derived_class >
auto self ( ) -> derived_class&
inlineprotected

Allows to return the right options builder instance for child implementations.

Returns
derived_class
Since
1.0.0
Internal
Internal interface

◆ timeout()

template<typename derived_class >
auto timeout ( const std::chrono::milliseconds timeout) -> derived_class&
inline

Specifies a custom per-operation timeout.

Note
: if a custom timeout is provided through this builder, it will override the default set on the environment.
Parameters
timeoutthe timeout to use for this operation.
Returns
this options builder for chaining purposes.
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: