Hazelcast C++ Client
Public Member Functions | List of all members
hazelcast::client::transaction_context Class Reference

Provides a context to do transactional operations; so beginning/committing transactions, but also retrieving transactional data-structures like the TransactionalMap. More...

#include <transaction_context.h>

Public Member Functions

 transaction_context (spi::impl::ClientTransactionManagerServiceImpl &transaction_manager, const transaction_options &)
 Constructor to be used internally. More...
 
boost::uuids::uuid get_txn_id () const
 
boost::future< void > begin_transaction ()
 Begins a transaction. More...
 
boost::future< void > commit_transaction ()
 Commits a transaction. More...
 
boost::future< void > rollback_transaction ()
 Begins a transaction. More...
 
std::shared_ptr< transactional_mapget_map (const std::string &name)
 Returns the transactional distributed map instance with the specified name. More...
 
std::shared_ptr< transactional_queueget_queue (const std::string &name)
 Returns the transactional queue instance with the specified name. More...
 
std::shared_ptr< transactional_multi_mapget_multi_map (const std::string &name)
 Returns the transactional multimap instance with the specified name. More...
 
std::shared_ptr< transactional_listget_list (const std::string &name)
 Returns the transactional list instance with the specified name. More...
 
std::shared_ptr< transactional_setget_set (const std::string &name)
 Returns the transactional set instance with the specified name. More...
 
template<typename T >
std::shared_ptr< T > get_transactional_object (const std::string &service_name, const std::string &name)
 get any transactional object with template T. More...
 

Detailed Description

Provides a context to do transactional operations; so beginning/committing transactions, but also retrieving transactional data-structures like the TransactionalMap.

See also
hazelcast_client::newTransactionContext

Constructor & Destructor Documentation

◆ transaction_context()

hazelcast::client::transaction_context::transaction_context ( spi::impl::ClientTransactionManagerServiceImpl &  transaction_manager,
const transaction_options txn_options 
)

Constructor to be used internally.

Not public API.

Member Function Documentation

◆ begin_transaction()

boost::future< void > hazelcast::client::transaction_context::begin_transaction ( )

Begins a transaction.

Exceptions
illegal_stateif a transaction already is active.

◆ commit_transaction()

boost::future< void > hazelcast::client::transaction_context::commit_transaction ( )

Commits a transaction.

Exceptions
transactionif no transaction is active or the transaction could not be committed.

◆ get_list()

std::shared_ptr<transactional_list> hazelcast::client::transaction_context::get_list ( const std::string &  name)
inline

Returns the transactional list instance with the specified name.

Parameters
namename of the list
Returns
transactional list instance with the specified name

◆ get_map()

std::shared_ptr<transactional_map> hazelcast::client::transaction_context::get_map ( const std::string &  name)
inline

Returns the transactional distributed map instance with the specified name.

Parameters
namename of the distributed map
Returns
transactional distributed map instance with the specified name

◆ get_multi_map()

std::shared_ptr<transactional_multi_map> hazelcast::client::transaction_context::get_multi_map ( const std::string &  name)
inline

Returns the transactional multimap instance with the specified name.

Parameters
namename of the multimap
Returns
transactional multimap instance with the specified name

◆ get_queue()

std::shared_ptr<transactional_queue> hazelcast::client::transaction_context::get_queue ( const std::string &  name)
inline

Returns the transactional queue instance with the specified name.

Parameters
namename of the queue
Returns
transactional queue instance with the specified name

◆ get_set()

std::shared_ptr<transactional_set> hazelcast::client::transaction_context::get_set ( const std::string &  name)
inline

Returns the transactional set instance with the specified name.

Parameters
namename of the set
Returns
transactional set instance with the specified name

◆ get_transactional_object()

template<typename T >
std::shared_ptr<T> hazelcast::client::transaction_context::get_transactional_object ( const std::string &  service_name,
const std::string &  name 
)
inline

get any transactional object with template T.

Mostly to be used by spi implementers of Hazelcast.

Returns
transactionalObject.

◆ get_txn_id()

boost::uuids::uuid hazelcast::client::transaction_context::get_txn_id ( ) const
Returns
txn id.

◆ rollback_transaction()

boost::future< void > hazelcast::client::transaction_context::rollback_transaction ( )

Begins a transaction.

Exceptions
illegal_stateif a transaction already is active.

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