blob: f56c794de08ef4d81aa01fb7f9deed6d10e3459d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: ignite::transactions::Transaction Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1transactions.html">transactions</a></li><li class="navelem"><a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1transactions_1_1Transaction-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::transactions::Transaction Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Ignite cache transaction.
<a href="classignite_1_1transactions_1_1Transaction.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="core_2include_2ignite_2transactions_2transaction_8h_source.html">transaction.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a323d59dcb2564aacb77d5907c3d15a52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a323d59dcb2564aacb77d5907c3d15a52">Transaction</a> (common::concurrent::SharedPointer&lt; impl::transactions::TransactionImpl &gt; impl)</td></tr>
<tr class="memdesc:a323d59dcb2564aacb77d5907c3d15a52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classignite_1_1transactions_1_1Transaction.html#a323d59dcb2564aacb77d5907c3d15a52">More...</a><br /></td></tr>
<tr class="separator:a323d59dcb2564aacb77d5907c3d15a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27c57187cac9a53d4fc1839f65e65f36"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a27c57187cac9a53d4fc1839f65e65f36">Transaction</a> (const <a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a> &amp;other)</td></tr>
<tr class="memdesc:a27c57187cac9a53d4fc1839f65e65f36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="classignite_1_1transactions_1_1Transaction.html#a27c57187cac9a53d4fc1839f65e65f36">More...</a><br /></td></tr>
<tr class="separator:a27c57187cac9a53d4fc1839f65e65f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f5f7ffba636a676f63d31ed7230a8eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a1f5f7ffba636a676f63d31ed7230a8eb">operator=</a> (const <a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a> &amp;other)</td></tr>
<tr class="memdesc:a1f5f7ffba636a676f63d31ed7230a8eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="classignite_1_1transactions_1_1Transaction.html#a1f5f7ffba636a676f63d31ed7230a8eb">More...</a><br /></td></tr>
<tr class="separator:a1f5f7ffba636a676f63d31ed7230a8eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51c698ca3933a26092d4d71db4064e98"><td class="memItemLeft" align="right" valign="top"><a id="a51c698ca3933a26092d4d71db4064e98"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a51c698ca3933a26092d4d71db4064e98">~Transaction</a> ()</td></tr>
<tr class="memdesc:a51c698ca3933a26092d4d71db4064e98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a51c698ca3933a26092d4d71db4064e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7536d728f02cfeb79266a1c1b111c37"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#aa7536d728f02cfeb79266a1c1b111c37">Commit</a> ()</td></tr>
<tr class="memdesc:aa7536d728f02cfeb79266a1c1b111c37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Commit the transaction. <a href="classignite_1_1transactions_1_1Transaction.html#aa7536d728f02cfeb79266a1c1b111c37">More...</a><br /></td></tr>
<tr class="separator:aa7536d728f02cfeb79266a1c1b111c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cbec407339fb78d1a50eaa165065206"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a6cbec407339fb78d1a50eaa165065206">Commit</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:a6cbec407339fb78d1a50eaa165065206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Commit the transaction. <a href="classignite_1_1transactions_1_1Transaction.html#a6cbec407339fb78d1a50eaa165065206">More...</a><br /></td></tr>
<tr class="separator:a6cbec407339fb78d1a50eaa165065206"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c28832d82d8dbff3414d2fb581949d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a4c28832d82d8dbff3414d2fb581949d4">Rollback</a> ()</td></tr>
<tr class="memdesc:a4c28832d82d8dbff3414d2fb581949d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rollback the transaction. <a href="classignite_1_1transactions_1_1Transaction.html#a4c28832d82d8dbff3414d2fb581949d4">More...</a><br /></td></tr>
<tr class="separator:a4c28832d82d8dbff3414d2fb581949d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e59e750656f388e90b5ad2e067f9863"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a8e59e750656f388e90b5ad2e067f9863">Rollback</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:a8e59e750656f388e90b5ad2e067f9863"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rollback the transaction. <a href="classignite_1_1transactions_1_1Transaction.html#a8e59e750656f388e90b5ad2e067f9863">More...</a><br /></td></tr>
<tr class="separator:a8e59e750656f388e90b5ad2e067f9863"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b274c90fd8256a90b8abf14565ea38c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a9b274c90fd8256a90b8abf14565ea38c">Close</a> ()</td></tr>
<tr class="memdesc:a9b274c90fd8256a90b8abf14565ea38c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the transaction. <a href="classignite_1_1transactions_1_1Transaction.html#a9b274c90fd8256a90b8abf14565ea38c">More...</a><br /></td></tr>
<tr class="separator:a9b274c90fd8256a90b8abf14565ea38c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af633d10c12d5ec27d7c97feade5754d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#af633d10c12d5ec27d7c97feade5754d0">Close</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:af633d10c12d5ec27d7c97feade5754d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the transaction. <a href="classignite_1_1transactions_1_1Transaction.html#af633d10c12d5ec27d7c97feade5754d0">More...</a><br /></td></tr>
<tr class="separator:af633d10c12d5ec27d7c97feade5754d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a346e9f015ab64052605014bedfe8dcb9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a346e9f015ab64052605014bedfe8dcb9">SetRollbackOnly</a> ()</td></tr>
<tr class="memdesc:a346e9f015ab64052605014bedfe8dcb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make transaction into rollback-only. <a href="classignite_1_1transactions_1_1Transaction.html#a346e9f015ab64052605014bedfe8dcb9">More...</a><br /></td></tr>
<tr class="separator:a346e9f015ab64052605014bedfe8dcb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e985369f83c4ac4c567ef6262cbff2d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a5e985369f83c4ac4c567ef6262cbff2d">SetRollbackOnly</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:a5e985369f83c4ac4c567ef6262cbff2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make transaction into rollback-only. <a href="classignite_1_1transactions_1_1Transaction.html#a5e985369f83c4ac4c567ef6262cbff2d">More...</a><br /></td></tr>
<tr class="separator:a5e985369f83c4ac4c567ef6262cbff2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61be2250627d6e22e012c66b18434022"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a61be2250627d6e22e012c66b18434022">IsRollbackOnly</a> ()</td></tr>
<tr class="memdesc:a61be2250627d6e22e012c66b18434022"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the transaction is rollback-only. <a href="classignite_1_1transactions_1_1Transaction.html#a61be2250627d6e22e012c66b18434022">More...</a><br /></td></tr>
<tr class="separator:a61be2250627d6e22e012c66b18434022"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54999612f0b62afdee3b853610b5b418"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a54999612f0b62afdee3b853610b5b418">IsRollbackOnly</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:a54999612f0b62afdee3b853610b5b418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the transaction is rollback-only. <a href="classignite_1_1transactions_1_1Transaction.html#a54999612f0b62afdee3b853610b5b418">More...</a><br /></td></tr>
<tr class="separator:a54999612f0b62afdee3b853610b5b418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fdf592086804ec3ce18148afae726b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1transactions_1_1TransactionState.html#a173faba612c6a4e91c0726140d8d43f3">TransactionState::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a6fdf592086804ec3ce18148afae726b1">GetState</a> ()</td></tr>
<tr class="memdesc:a6fdf592086804ec3ce18148afae726b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current state. <a href="classignite_1_1transactions_1_1Transaction.html#a6fdf592086804ec3ce18148afae726b1">More...</a><br /></td></tr>
<tr class="separator:a6fdf592086804ec3ce18148afae726b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a999f64e8b6673c9d4899e10e5a01abb2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1transactions_1_1TransactionState.html#a173faba612c6a4e91c0726140d8d43f3">TransactionState::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a999f64e8b6673c9d4899e10e5a01abb2">GetState</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:a999f64e8b6673c9d4899e10e5a01abb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current state. <a href="classignite_1_1transactions_1_1Transaction.html#a999f64e8b6673c9d4899e10e5a01abb2">More...</a><br /></td></tr>
<tr class="separator:a999f64e8b6673c9d4899e10e5a01abb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3764b3e1d9a5718dd2a1adc39232d0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1transactions_1_1TransactionConcurrency.html#ae4a4021eb1bbb6d2acdaad1defeb469a">TransactionConcurrency::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#af3764b3e1d9a5718dd2a1adc39232d0e">GetConcurrency</a> () const</td></tr>
<tr class="memdesc:af3764b3e1d9a5718dd2a1adc39232d0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get concurrency. <a href="classignite_1_1transactions_1_1Transaction.html#af3764b3e1d9a5718dd2a1adc39232d0e">More...</a><br /></td></tr>
<tr class="separator:af3764b3e1d9a5718dd2a1adc39232d0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae528b6116836bb0659fa72ff5002714d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1transactions_1_1TransactionIsolation.html#a3ac24463ce4e1f63186a974c33c6b3e3">TransactionIsolation::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#ae528b6116836bb0659fa72ff5002714d">GetIsolation</a> () const</td></tr>
<tr class="memdesc:ae528b6116836bb0659fa72ff5002714d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get isolation. <a href="classignite_1_1transactions_1_1Transaction.html#ae528b6116836bb0659fa72ff5002714d">More...</a><br /></td></tr>
<tr class="separator:ae528b6116836bb0659fa72ff5002714d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a685130f14959d840e46c64a9aa8d048f"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a685130f14959d840e46c64a9aa8d048f">GetTimeout</a> () const</td></tr>
<tr class="memdesc:a685130f14959d840e46c64a9aa8d048f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get timeout. <a href="classignite_1_1transactions_1_1Transaction.html#a685130f14959d840e46c64a9aa8d048f">More...</a><br /></td></tr>
<tr class="separator:a685130f14959d840e46c64a9aa8d048f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f96124829d7926fbf0e5f5e3b0d5da8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1transactions_1_1Transaction.html#a6f96124829d7926fbf0e5f5e3b0d5da8">IsValid</a> () const</td></tr>
<tr class="memdesc:a6f96124829d7926fbf0e5f5e3b0d5da8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the instance is valid and can be used. <a href="classignite_1_1transactions_1_1Transaction.html#a6f96124829d7926fbf0e5f5e3b0d5da8">More...</a><br /></td></tr>
<tr class="separator:a6f96124829d7926fbf0e5f5e3b0d5da8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Ignite cache transaction. </p>
<p>Cache transactions have a default 2PC (two-phase-commit) behavior.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structignite_1_1transactions_1_1TransactionConcurrency.html" title="Transaction concurrency control model.">TransactionConcurrency</a> and <a class="el" href="structignite_1_1transactions_1_1TransactionIsolation.html" title="Defines different cache transaction isolation levels.">TransactionIsolation</a> for details on the supported isolation levels and concurrency models.</dd></dl>
<p>This class is implemented as a reference to an implementation so copying of this class instance will only create another reference to the same underlying object. Underlying object will be released automatically once all the instances are destructed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a323d59dcb2564aacb77d5907c3d15a52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a323d59dcb2564aacb77d5907c3d15a52">&#9670;&nbsp;</a></span>Transaction() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ignite::transactions::Transaction::Transaction </td>
<td>(</td>
<td class="paramtype">common::concurrent::SharedPointer&lt; impl::transactions::TransactionImpl &gt;&#160;</td>
<td class="paramname"><em>impl</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Internal method. Should not be used by user.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impl</td><td>Implementation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a27c57187cac9a53d4fc1839f65e65f36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27c57187cac9a53d4fc1839f65e65f36">&#9670;&nbsp;</a></span>Transaction() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ignite::transactions::Transaction::Transaction </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Other instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9b274c90fd8256a90b8abf14565ea38c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b274c90fd8256a90b8abf14565ea38c">&#9670;&nbsp;</a></span>Close() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::Close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the transaction. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>class instance in case of failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af633d10c12d5ec27d7c97feade5754d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af633d10c12d5ec27d7c97feade5754d0">&#9670;&nbsp;</a></span>Close() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::Close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the transaction. </p>
<p>Properly sets error param in case of failure.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa7536d728f02cfeb79266a1c1b111c37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7536d728f02cfeb79266a1c1b111c37">&#9670;&nbsp;</a></span>Commit() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::Commit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commit the transaction. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>class instance in case of failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6cbec407339fb78d1a50eaa165065206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cbec407339fb78d1a50eaa165065206">&#9670;&nbsp;</a></span>Commit() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::Commit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commit the transaction. </p>
<p>Properly sets error param in case of failure.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af3764b3e1d9a5718dd2a1adc39232d0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3764b3e1d9a5718dd2a1adc39232d0e">&#9670;&nbsp;</a></span>GetConcurrency()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structignite_1_1transactions_1_1TransactionConcurrency.html#ae4a4021eb1bbb6d2acdaad1defeb469a">TransactionConcurrency::Type</a> ignite::transactions::Transaction::GetConcurrency </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get concurrency. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="section return"><dt>Returns</dt><dd>Concurrency. </dd></dl>
</div>
</div>
<a id="ae528b6116836bb0659fa72ff5002714d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae528b6116836bb0659fa72ff5002714d">&#9670;&nbsp;</a></span>GetIsolation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structignite_1_1transactions_1_1TransactionIsolation.html#a3ac24463ce4e1f63186a974c33c6b3e3">TransactionIsolation::Type</a> ignite::transactions::Transaction::GetIsolation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get isolation. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="section return"><dt>Returns</dt><dd>Isolation. </dd></dl>
</div>
</div>
<a id="a6fdf592086804ec3ce18148afae726b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fdf592086804ec3ce18148afae726b1">&#9670;&nbsp;</a></span>GetState() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structignite_1_1transactions_1_1TransactionState.html#a173faba612c6a4e91c0726140d8d43f3">TransactionState::Type</a> ignite::transactions::Transaction::GetState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current state. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classignite_1_1transactions_1_1Transaction.html" title="Ignite cache transaction.">Transaction</a> state.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>class instance in case of failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a999f64e8b6673c9d4899e10e5a01abb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a999f64e8b6673c9d4899e10e5a01abb2">&#9670;&nbsp;</a></span>GetState() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structignite_1_1transactions_1_1TransactionState.html#a173faba612c6a4e91c0726140d8d43f3">TransactionState::Type</a> ignite::transactions::Transaction::GetState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current state. </p>
<p>Properly sets error param in case of failure.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classignite_1_1transactions_1_1Transaction.html" title="Ignite cache transaction.">Transaction</a> state. </dd></dl>
</div>
</div>
<a id="a685130f14959d840e46c64a9aa8d048f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a685130f14959d840e46c64a9aa8d048f">&#9670;&nbsp;</a></span>GetTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int64_t ignite::transactions::Transaction::GetTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get timeout. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="section return"><dt>Returns</dt><dd>Timeout in milliseconds. Zero if timeout is infinite. </dd></dl>
</div>
</div>
<a id="a61be2250627d6e22e012c66b18434022"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61be2250627d6e22e012c66b18434022">&#9670;&nbsp;</a></span>IsRollbackOnly() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ignite::transactions::Transaction::IsRollbackOnly </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the transaction is rollback-only. </p>
<p>After transaction have been marked as rollback-only it may only be rolled back. Error occurs if such transaction is being commited.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the transaction is rollback-only.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>class instance in case of failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a54999612f0b62afdee3b853610b5b418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54999612f0b62afdee3b853610b5b418">&#9670;&nbsp;</a></span>IsRollbackOnly() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ignite::transactions::Transaction::IsRollbackOnly </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the transaction is rollback-only. </p>
<p>After transaction have been marked as rollback-only it may only be rolled back. Error occurs if such transaction is being commited.</p>
<p>Properly sets error param in case of failure.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the transaction is rollback-only. </dd></dl>
</div>
</div>
<a id="a6f96124829d7926fbf0e5f5e3b0d5da8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f96124829d7926fbf0e5f5e3b0d5da8">&#9670;&nbsp;</a></span>IsValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ignite::transactions::Transaction::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the instance is valid and can be used. </p>
<p>Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the instance is valid and can be used. </dd></dl>
</div>
</div>
<a id="a1f5f7ffba636a676f63d31ed7230a8eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f5f7ffba636a676f63d31ed7230a8eb">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a> &amp; ignite::transactions::Transaction::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1transactions_1_1Transaction.html">Transaction</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Other instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This. </dd></dl>
</div>
</div>
<a id="a4c28832d82d8dbff3414d2fb581949d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c28832d82d8dbff3414d2fb581949d4">&#9670;&nbsp;</a></span>Rollback() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::Rollback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rollback the transaction. </p>
<p>This method should only be used on the valid instance.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>class instance in case of failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8e59e750656f388e90b5ad2e067f9863"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e59e750656f388e90b5ad2e067f9863">&#9670;&nbsp;</a></span>Rollback() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::Rollback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rollback the transaction. </p>
<p>Properly sets error param in case of failure.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a346e9f015ab64052605014bedfe8dcb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a346e9f015ab64052605014bedfe8dcb9">&#9670;&nbsp;</a></span>SetRollbackOnly() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::SetRollbackOnly </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make transaction into rollback-only. </p>
<p>After transaction have been marked as rollback-only it may only be rolled back. Error occurs if such transaction is being commited.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a></td><td>class instance in case of failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5e985369f83c4ac4c567ef6262cbff2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e985369f83c4ac4c567ef6262cbff2d">&#9670;&nbsp;</a></span>SetRollbackOnly() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::transactions::Transaction::SetRollbackOnly </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make transaction into rollback-only. </p>
<p>After transaction have been marked as rollback-only it may only be rolled back. Error occurs if such transaction is being commited.</p>
<p>Properly sets error param in case of failure.</p>
<p>This method should only be used on the valid instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="core_2include_2ignite_2transactions_2transaction_8h_source.html">core/include/ignite/transactions/transaction.h</a></li>
<li>transaction.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>