Couchbase Transactions C++ Client  1.0.0
Transactions client for couchbase
Public Member Functions | List of all members
couchbase::common_mutate_options< T > Class Template Reference

Options common to mutation operations. More...

#include <options.hxx>

Inheritance diagram for couchbase::common_mutate_options< T >:
couchbase::common_options< T >

Public Member Functions

CB_NODISCARD boost::optional< uint64_t > cas () const
 Get cas. More...
 
T & cas (uint64_t cas)
 Set current CAS. More...
 
CB_NODISCARD boost::optional< durability_leveldurability () const
 Get Durability. More...
 
T & durability (durability_level level)
 Set durability. More...
 
- Public Member Functions inherited from couchbase::common_options< T >
CB_NODISCARD boost::optional< std::chrono::microseconds > timeout () const
 get timeout More...
 
template<typename R >
T & timeout (R timeout)
 Set timeout. More...
 

Detailed Description

template<typename T>
class couchbase::common_mutate_options< T >

Options common to mutation operations.

Member Function Documentation

◆ cas() [1/2]

template<typename T>
CB_NODISCARD boost::optional<uint64_t> couchbase::common_mutate_options< T >::cas ( ) const
inline

Get cas.

Returns
The cas, if set.

◆ cas() [2/2]

template<typename T>
T& couchbase::common_mutate_options< T >::cas ( uint64_t  cas)
inline

Set current CAS.

Parameters
casthe current CAS of the document. Mutation will fail with a result code of LCB_ERR_CAS_MISMATCH when this doesn't match the current CAS of the document. Ignored if 0.
Returns
A reference to this object, so the calls can be chained.

◆ durability() [1/2]

template<typename T>
CB_NODISCARD boost::optional<durability_level> couchbase::common_mutate_options< T >::durability ( ) const
inline

Get Durability.

Returns
the durability_level set in this object.

◆ durability() [2/2]

template<typename T>
T& couchbase::common_mutate_options< T >::durability ( durability_level  level)
inline

Set durability.

Parameters
levelDesired durability_level for the mutation operation.
Returns
Reference to this object, so calls can be chained.

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