fb-cpp 0.0.2
A modern C++ wrapper for the Firebird database API
Loading...
Searching...
No Matches
fbcpp::TransactionOptions Class Referencefinal

Represents options used when creating a Transaction object. More...

#include <Transaction.h>

Public Member Functions

const std::vector< std::uint8_t > & getTpb () const
 Returns the TPB (Transaction Parameter Block) which will be used to start the transaction.
 
TransactionOptions & setTpb (const std::vector< std::uint8_t > &value)
 Sets the TPB (Transaction Parameter Block) which will be used to start the transaction.
 
TransactionOptions & setTpb (std::vector< std::uint8_t > &&value)
 Sets the TPB (Transaction Parameter Block) which will be used to start the transaction.
 
const std::optional< TransactionIsolationLevel > getIsolationLevel () const
 Returns the transaction isolation level.
 
TransactionOptions & setIsolationLevel (TransactionIsolationLevel value)
 Sets the transaction isolation level.
 
const std::optional< TransactionReadCommittedMode > getReadCommittedMode () const
 Returns the read committed mode.
 
TransactionOptions & setReadCommittedMode (TransactionReadCommittedMode value)
 Sets the read committed mode.
 
const std::optional< TransactionAccessMode > getAccessMode () const
 Returns the transaction access mode.
 
TransactionOptions & setAccessMode (TransactionAccessMode value)
 Sets the transaction access mode.
 
const std::optional< TransactionWaitMode > getWaitMode () const
 Returns the transaction wait mode.
 
TransactionOptions & setWaitMode (TransactionWaitMode value)
 Sets the transaction wait mode.
 
bool getNoAutoUndo () const
 Returns whether the transaction will not automatically undo changes in case of a deadlock or update conflict.
 
TransactionOptions & setNoAutoUndo (bool value)
 Sets whether the transaction will not automatically undo changes in case of a deadlock or update conflict.
 
bool getIgnoreLimbo () const
 Returns whether the transaction will ignore limbo transactions.
 
TransactionOptions & setIgnoreLimbo (bool value)
 Sets whether the transaction will ignore limbo transactions.
 
bool getRestartRequests () const
 Returns whether the transaction will restart requests.
 
TransactionOptions & setRestartRequests (bool value)
 Sets whether the transaction will restart requests.
 
bool getAutoCommit () const
 Returns whether the transaction will be automatically committed.
 
TransactionOptions & setAutoCommit (bool value)
 Sets whether the transaction will be automatically committed.
 

Detailed Description

Represents options used when creating a Transaction object.

Definition at line 121 of file Transaction.h.

Member Function Documentation

◆ getAccessMode()

const std::optional< TransactionAccessMode > fbcpp::TransactionOptions::getAccessMode ( ) const
inline

Returns the transaction access mode.

Definition at line 190 of file Transaction.h.

◆ getAutoCommit()

bool fbcpp::TransactionOptions::getAutoCommit ( ) const
inline

Returns whether the transaction will be automatically committed.

Definition at line 277 of file Transaction.h.

◆ getIgnoreLimbo()

bool fbcpp::TransactionOptions::getIgnoreLimbo ( ) const
inline

Returns whether the transaction will ignore limbo transactions.

Definition at line 243 of file Transaction.h.

◆ getIsolationLevel()

const std::optional< TransactionIsolationLevel > fbcpp::TransactionOptions::getIsolationLevel ( ) const
inline

Returns the transaction isolation level.

Definition at line 156 of file Transaction.h.

◆ getNoAutoUndo()

bool fbcpp::TransactionOptions::getNoAutoUndo ( ) const
inline

Returns whether the transaction will not automatically undo changes in case of a deadlock or update conflict.

Definition at line 225 of file Transaction.h.

◆ getReadCommittedMode()

const std::optional< TransactionReadCommittedMode > fbcpp::TransactionOptions::getReadCommittedMode ( ) const
inline

Returns the read committed mode.

Definition at line 173 of file Transaction.h.

◆ getRestartRequests()

bool fbcpp::TransactionOptions::getRestartRequests ( ) const
inline

Returns whether the transaction will restart requests.

Definition at line 260 of file Transaction.h.

◆ getTpb()

const std::vector< std::uint8_t > & fbcpp::TransactionOptions::getTpb ( ) const
inline

Returns the TPB (Transaction Parameter Block) which will be used to start the transaction.

Definition at line 128 of file Transaction.h.

◆ getWaitMode()

const std::optional< TransactionWaitMode > fbcpp::TransactionOptions::getWaitMode ( ) const
inline

Returns the transaction wait mode.

Definition at line 207 of file Transaction.h.

◆ setAccessMode()

TransactionOptions & fbcpp::TransactionOptions::setAccessMode ( TransactionAccessMode  value)
inline

Sets the transaction access mode.

Definition at line 198 of file Transaction.h.

◆ setAutoCommit()

TransactionOptions & fbcpp::TransactionOptions::setAutoCommit ( bool  value)
inline

Sets whether the transaction will be automatically committed.

Definition at line 285 of file Transaction.h.

◆ setIgnoreLimbo()

TransactionOptions & fbcpp::TransactionOptions::setIgnoreLimbo ( bool  value)
inline

Sets whether the transaction will ignore limbo transactions.

Definition at line 251 of file Transaction.h.

◆ setIsolationLevel()

TransactionOptions & fbcpp::TransactionOptions::setIsolationLevel ( TransactionIsolationLevel  value)
inline

Sets the transaction isolation level.

Definition at line 164 of file Transaction.h.

◆ setNoAutoUndo()

TransactionOptions & fbcpp::TransactionOptions::setNoAutoUndo ( bool  value)
inline

Sets whether the transaction will not automatically undo changes in case of a deadlock or update conflict.

Definition at line 234 of file Transaction.h.

◆ setReadCommittedMode()

TransactionOptions & fbcpp::TransactionOptions::setReadCommittedMode ( TransactionReadCommittedMode  value)
inline

Sets the read committed mode.

Definition at line 181 of file Transaction.h.

◆ setRestartRequests()

TransactionOptions & fbcpp::TransactionOptions::setRestartRequests ( bool  value)
inline

Sets whether the transaction will restart requests.

Definition at line 268 of file Transaction.h.

◆ setTpb() [1/2]

TransactionOptions & fbcpp::TransactionOptions::setTpb ( const std::vector< std::uint8_t > &  value)
inline

Sets the TPB (Transaction Parameter Block) which will be used to start the transaction.

Definition at line 137 of file Transaction.h.

◆ setTpb() [2/2]

TransactionOptions & fbcpp::TransactionOptions::setTpb ( std::vector< std::uint8_t > &&  value)
inline

Sets the TPB (Transaction Parameter Block) which will be used to start the transaction.

Definition at line 147 of file Transaction.h.

◆ setWaitMode()

TransactionOptions & fbcpp::TransactionOptions::setWaitMode ( TransactionWaitMode  value)
inline

Sets the transaction wait mode.

Definition at line 215 of file Transaction.h.


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