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.
boost::uuids::uuid	get_txn_id () const
boost::future< void >	begin_transaction ()
	Begins a transaction.
boost::future< void >	commit_transaction ()
	Commits a transaction.
boost::future< void >	rollback_transaction ()
	Begins a transaction.
std::shared_ptr< transactional_map >	get_map (const std::string &name)
	Returns the transactional distributed map instance with the specified name.
std::shared_ptr< transactional_queue >	get_queue (const std::string &name)
	Returns the transactional queue instance with the specified name.
std::shared_ptr< transactional_multi_map >	get_multi_map (const std::string &name)
	Returns the transactional multimap instance with the specified name.
std::shared_ptr< transactional_list >	get_list (const std::string &name)
	Returns the transactional list instance with the specified name.
std::shared_ptr< transactional_set >	get_set (const std::string &name)
	Returns the transactional set instance with the specified name.
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.

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

Definition at line 68 of file transaction_context.h.

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.

Definition at line 715 of file transactions.cpp.

  : options_(txn_options)
  , txn_connection_(transaction_manager.connect())
  , transaction_(options_, transaction_manager.get_client(), txn_connection_)
{}

Member Function Documentation

◆ begin_transaction()

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

Begins a transaction.

Exceptions

illegal_state if a transaction already is active.

Definition at line 730 of file transactions.cpp.

{
    return transaction_.begin();
}

◆ commit_transaction()

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

Commits a transaction.

Exceptions

transaction if no transaction is active or the transaction could not be committed.

Definition at line 736 of file transactions.cpp.

{
    return transaction_.commit();
}

◆ 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

name	name of the list

Returns: transactional list instance with the specified name

Definition at line 154 of file transaction_context.h.

    {
        return get_transactional_object<transactional_list>(ilist::SERVICE_NAME,
                                                            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

name	name of the distributed map

Returns: transactional distributed map instance with the specified name

Definition at line 114 of file transaction_context.h.

    {
        return get_transactional_object<transactional_map>(imap::SERVICE_NAME,
                                                           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

name	name of the multimap

Returns: transactional multimap instance with the specified name

Definition at line 140 of file transaction_context.h.

    {
        return get_transactional_object<transactional_multi_map>(
          multi_map::SERVICE_NAME, 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

name	name of the queue

Returns: transactional queue instance with the specified name

Definition at line 127 of file transaction_context.h.

    {
        return get_transactional_object<transactional_queue>(
          iqueue::SERVICE_NAME, 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

name	name of the set

Returns: transactional set instance with the specified name

Definition at line 167 of file transaction_context.h.

    {
        return get_transactional_object<transactional_set>(iset::SERVICE_NAME,
                                                           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.

Definition at line 181 of file transaction_context.h.

    {
        if (transaction_.get_state() != txn::TxnState::ACTIVE) {
            std::string message = "No transaction is found while accessing ";
            message += "transactional object -> [" + name + "]!";
            BOOST_THROW_EXCEPTION(exception::illegal_state(
              "TransactionContext::getMap(const std::string& name)", message));
        }
        auto key = std::make_pair(service_name, name);
        std::shared_ptr<T> obj =
          std::static_pointer_cast<T>(txn_object_map_.get(key));
        if (!obj) {
            obj = std::shared_ptr<T>(new T(name, transaction_));
            txn_object_map_.put(key, obj);
        }
 
        return obj;
    }

◆ get_txn_id()

boost::uuids::uuid hazelcast::client::transaction_context::get_txn_id ( ) const

Returns: txn id.

Definition at line 724 of file transactions.cpp.

{
    return transaction_.get_txn_id();
}

◆ rollback_transaction()

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

Begins a transaction.

Exceptions

illegal_state if a transaction already is active.

Definition at line 742 of file transactions.cpp.

{
    return transaction_.rollback();
}

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

hazelcast/include/hazelcast/client/transaction_context.h
hazelcast/src/hazelcast/client/transactions.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ transaction_context()

Member Function Documentation

◆ begin_transaction()

◆ commit_transaction()

◆ get_list()

◆ get_map()

◆ get_multi_map()

◆ get_queue()

◆ get_set()

◆ get_transactional_object()

◆ get_txn_id()

◆ rollback_transaction()