blob: 93074e92718beb9c6cc6ffec97c42f5690620a80 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: ignite::thin::transactions::ClientTransaction 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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_1thin.html">thin</a></li><li class="navelem"><b>transactions</b></li><li class="navelem"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html">ClientTransaction</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_1thin_1_1transactions_1_1ClientTransaction-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::thin::transactions::ClientTransaction Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Transaction client.
<a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="thin-client_2include_2ignite_2thin_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:a701fc4d530d868c2c6cbda2ad4e76105"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a701fc4d530d868c2c6cbda2ad4e76105">ClientTransaction</a> (ignite::impl::thin::transactions::TransactionProxy impl)</td></tr>
<tr class="memdesc:a701fc4d530d868c2c6cbda2ad4e76105"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a701fc4d530d868c2c6cbda2ad4e76105">More...</a><br /></td></tr>
<tr class="separator:a701fc4d530d868c2c6cbda2ad4e76105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a267e1fd42679b8ee58e75173cd0a4e7e"><td class="memItemLeft" align="right" valign="top"><a id="a267e1fd42679b8ee58e75173cd0a4e7e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a267e1fd42679b8ee58e75173cd0a4e7e">ClientTransaction</a> ()</td></tr>
<tr class="memdesc:a267e1fd42679b8ee58e75173cd0a4e7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a267e1fd42679b8ee58e75173cd0a4e7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59f9dbbe83fdfda17315dd09e4055d87"><td class="memItemLeft" align="right" valign="top"><a id="a59f9dbbe83fdfda17315dd09e4055d87"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a59f9dbbe83fdfda17315dd09e4055d87">~ClientTransaction</a> ()</td></tr>
<tr class="memdesc:a59f9dbbe83fdfda17315dd09e4055d87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a59f9dbbe83fdfda17315dd09e4055d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7936e95b0af9a4cf1a134a644f3eaddb"><td class="memItemLeft" align="right" valign="top"><a id="a7936e95b0af9a4cf1a134a644f3eaddb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a7936e95b0af9a4cf1a134a644f3eaddb">Commit</a> ()</td></tr>
<tr class="memdesc:a7936e95b0af9a4cf1a134a644f3eaddb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Commits this transaction. <br /></td></tr>
<tr class="separator:a7936e95b0af9a4cf1a134a644f3eaddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a623ba4570863ba9a73164f164a2d64fe"><td class="memItemLeft" align="right" valign="top"><a id="a623ba4570863ba9a73164f164a2d64fe"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a623ba4570863ba9a73164f164a2d64fe">Rollback</a> ()</td></tr>
<tr class="memdesc:a623ba4570863ba9a73164f164a2d64fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rolls back this transaction. <br /></td></tr>
<tr class="separator:a623ba4570863ba9a73164f164a2d64fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94740b446683fb133bdd1f3f2c3b0383"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a94740b446683fb133bdd1f3f2c3b0383">Close</a> ()</td></tr>
<tr class="memdesc:a94740b446683fb133bdd1f3f2c3b0383"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends the transaction. <a href="#a94740b446683fb133bdd1f3f2c3b0383">More...</a><br /></td></tr>
<tr class="separator:a94740b446683fb133bdd1f3f2c3b0383"><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>Transaction client. </p>
<p>Implements main transactionsl API.</p>
<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="a701fc4d530d868c2c6cbda2ad4e76105"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a701fc4d530d868c2c6cbda2ad4e76105">&#9670;&nbsp;</a></span>ClientTransaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::thin::transactions::ClientTransaction::ClientTransaction </td>
<td>(</td>
<td class="paramtype">ignite::impl::thin::transactions::TransactionProxy&#160;</td>
<td class="paramname"><em>impl</em></td><td>)</td>
<td></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>Constructor. </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a94740b446683fb133bdd1f3f2c3b0383"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94740b446683fb133bdd1f3f2c3b0383">&#9670;&nbsp;</a></span>Close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ignite::thin::transactions::ClientTransaction::Close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Ends the transaction. </p>
<p>Transaction will be rolled back if it has not been committed. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thin-client_2include_2ignite_2thin_2transactions_2transaction_8h_source.html">thin-client/include/ignite/thin/transactions/transaction.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Sep 11 2021 21:14:00 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.13
</small></address>
</body>
</html>