get_and_lock_options Struct Reference

Options for collection::get_and_lock(). More...

#include <couchbase/get_and_lock_options.hxx>

Inheritance diagram for get_and_lock_options:

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

Public Member Functions
auto	build () const -> built
	Validates options and returns them as an immutable value.
Public Member Functions inherited from common_options< get_and_lock_options >
auto	timeout (const std::chrono::milliseconds timeout) -> get_and_lock_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> get_and_lock_options &
	Specifies a custom couchbase::retry_strategy for this operation.
auto	parent_span (std::shared_ptr< tracing::request_span > span) -> get_and_lock_options &

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

Detailed Description

Options for collection::get_and_lock().

Since

1.0.0

Committed

Generally available API and should be preferred in production

Examples

distributed_mutex.cxx.

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

Validates options and returns them as an immutable value.

Returns

consistent options as an immutable value

Exceptions

std::system_error

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

Since

1.0.0

Internal

Internal interface

---

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

• couchbase/get_and_lock_options.hxx