simpleTransaction Class Reference

Tracks a sequence of processes that should be treated as one atomic operation. More...

#include <simpletransaction.h>

Inheritance diagram for simpleTransaction:

Public Member Functions
	simpleTransaction ()
	Construct a simpleTransaction in its initial idle state.
void	transactionStart ()
	transactionStart this function is used to mark start of the sequence of processes that shall be treated as one operation.
void	transactionAdd (Enums::PROCESS process)
	transactionAdd If called after call to transactionStart() and before transactionEnd(), this method marks given process as next step in transaction. Otherwise it marks given process as the only step in transaction(it's value is treated as transaction result).
void	transactionEnd (Enums::PROCESS process)
	transactionEnd marks end of transaction
auto	transactionIsOver (Enums::PROCESS current) -> Enums::PROCESS
	transactionIsOver checks wheather currently finished process is last in current transaction

Detailed Description

Tracks a sequence of processes that should be treated as one atomic operation.

Definition at line 14 of file simpletransaction.h.

Constructor & Destructor Documentation

simpleTransaction()

simpleTransaction::simpleTransaction ( )

inline

Construct a simpleTransaction in its initial idle state.

Definition at line 23 of file simpletransaction.h.

Here is the caller graph for this function:

Member Function Documentation

transactionAdd()

void simpleTransaction::transactionAdd

(

Enums::PROCESS

process

)

transactionAdd If called after call to transactionStart() and before transactionEnd(), this method marks given process as next step in transaction. Otherwise it marks given process as the only step in transaction(it's value is treated as transaction result).

Parameters

process

process that shall be treated as part of transaction

transactionEnd()

void simpleTransaction::transactionEnd

(

Enums::PROCESS

process

)

transactionEnd marks end of transaction

Parameters

process

value that will be used as a result of transaction

transactionIsOver()

auto simpleTransaction::transactionIsOver

(

Enums::PROCESS

current

)

-> Enums::PROCESS

transactionIsOver checks wheather currently finished process is last in current transaction

Parameters

current

the process that just finished.

Returns

result of transaction as set by transactionAdd or transactionEnd if the transaction is over or Enums::INVALID if it's not yet over

---

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

• src/simpletransaction.h