mongocxx::options::transaction Class Reference

Class representing the optional arguments for a transaction. More...

#include <transaction.hpp>

Public Member Functions
	transaction (const transaction &)
	Copy constructs transaction options.
transaction &	operator= (const transaction &)
	Copy assigns transaction options.
	transaction (transaction &&) noexcept
	Move constructs transaction options.
transaction &	operator= (transaction &&) noexcept
	Move assigns transaction options.
	~transaction () noexcept
	Destroys the transaction options.
transaction &	read_concern (const class read_concern &rc)
	Sets the transaction read concern. More...
stdx::optional< class read_concern >	read_concern () const
	Gets the current transaction read concern. More...
transaction &	write_concern (const class write_concern &wc)
	Sets the transaction write concern. More...
stdx::optional< class write_concern >	write_concern () const
	Gets the current transaction write concern. More...
transaction &	read_preference (const class read_preference &rp)
	Sets the transaction read preference. More...
stdx::optional< class read_preference >	read_preference () const
	Gets the current transaction read preference. More...
transaction &	max_commit_time_ms (std::chrono::milliseconds ms)
	Sets the transaction's max commit time, in milliseconds. More...
stdx::optional< std::chrono::milliseconds >	max_commit_time_ms () const
	Gets the current transaction commit time, in milliseconds. More...

Detailed Description

Class representing the optional arguments for a transaction.

Member Function Documentation

max_commit_time_ms() [1/2]

stdx::optional<std::chrono::milliseconds> mongocxx::options::transaction::max_commit_time_ms

(

)

const

Gets the current transaction commit time, in milliseconds.

Returns

An optional containing the timeout. If the max commit time has not been set, a disengaged optional is returned.

max_commit_time_ms() [2/2]

transaction& mongocxx::options::transaction::max_commit_time_ms

(

std::chrono::milliseconds

ms

)

Sets the transaction's max commit time, in milliseconds.

Parameters

ms	The max commit time in milliseconds.

Returns

A reference to the object on which this function is being called.

read_concern() [1/2]

stdx::optional<class read_concern> mongocxx::options::transaction::read_concern

(

)

const

Gets the current transaction read concern.

Returns

An optional containing the read concern. If the read concern has not been set, a disengaged optional is returned.

read_concern() [2/2]

transaction& mongocxx::options::transaction::read_concern

(

const class read_concern &

rc

)

Sets the transaction read concern.

Parameters

rc	The read concern.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

read_preference() [1/2]

stdx::optional<class read_preference> mongocxx::options::transaction::read_preference

(

)

const

Gets the current transaction read preference.

Returns

An optional containing the read preference. If the read preference has not been set, a disengaged optional is returned.

read_preference() [2/2]

transaction& mongocxx::options::transaction::read_preference

(

const class read_preference &

rp

)

Sets the transaction read preference.

Parameters

rp	The read preference.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

write_concern() [1/2]

stdx::optional<class write_concern> mongocxx::options::transaction::write_concern

(

)

const

Gets the current transaction write concern.

Returns

The write concern.

An optional containing the write concern. If the write concern has not been set, a disengaged optional is returned.

write_concern() [2/2]

transaction& mongocxx::options::transaction::write_concern

(

const class write_concern &

wc

)

Sets the transaction write concern.

Parameters

wc	The write concern.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

---

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

• src/mongocxx/options/transaction.hpp
• src/mongocxx/read_concern.hpp
• src/mongocxx/read_preference.hpp
• src/mongocxx/write_concern.hpp