blob: e9bd264e1b8296a921c752a2f4a59d98825c6ea3 [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++: transaction.h Source File</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="dir_6917c354dff0dc051d18bd3bcc3faea1.html">include</a></li><li class="navelem"><a class="el" href="dir_3785354546cb37560a212b468c73f89f.html">ignite</a></li><li class="navelem"><a class="el" href="dir_097f68cb7241bfc683e7bdc6c58a7783.html">thin</a></li><li class="navelem"><a class="el" href="dir_76f0727524870bda1c3ee4b0c7b92872.html">transactions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">thin-client/include/ignite/thin/transactions/transaction.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#ifndef _IGNITE_THIN_TRANSACTIONS_CLIENT_TRANSACTION</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define _IGNITE_THIN_TRANSACTIONS_CLIENT_TRANSACTION</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;ignite/impl/thin/transactions/transactions_proxy.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">namespace </span>thin</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">namespace </span>transactions</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html"> 38</a></span>&#160; <span class="keyword">class </span><a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html">ClientTransaction</a> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a701fc4d530d868c2c6cbda2ad4e76105"> 46</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a701fc4d530d868c2c6cbda2ad4e76105">ClientTransaction</a>(ignite::impl::thin::transactions::TransactionProxy impl) :</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; proxy(impl)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a267e1fd42679b8ee58e75173cd0a4e7e"> 55</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a267e1fd42679b8ee58e75173cd0a4e7e">ClientTransaction</a>()</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a59f9dbbe83fdfda17315dd09e4055d87"> 63</a></span>&#160; <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a59f9dbbe83fdfda17315dd09e4055d87">~ClientTransaction</a>()</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a7936e95b0af9a4cf1a134a644f3eaddb"> 71</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a7936e95b0af9a4cf1a134a644f3eaddb">Commit</a>()</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; proxy.commit();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a623ba4570863ba9a73164f164a2d64fe"> 79</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a623ba4570863ba9a73164f164a2d64fe">Rollback</a>()</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; proxy.rollback();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; }</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a94740b446683fb133bdd1f3f2c3b0383"> 87</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a94740b446683fb133bdd1f3f2c3b0383">Close</a>()</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; proxy.close();</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; ignite::impl::thin::transactions::TransactionProxy proxy;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; };</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; }</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="preprocessor">#endif // _IGNITE_THIN_TRANSACTIONS_CLIENT_TRANSACTION</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceignite_html"><div class="ttname"><a href="namespaceignite.html">ignite</a></div><div class="ttdoc">Apache Ignite API.</div><div class="ttdef"><b>Definition:</b> cache.h:48</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html_a267e1fd42679b8ee58e75173cd0a4e7e"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a267e1fd42679b8ee58e75173cd0a4e7e">ignite::thin::transactions::ClientTransaction::ClientTransaction</a></div><div class="ttdeci">ClientTransaction()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:55</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html_a94740b446683fb133bdd1f3f2c3b0383"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a94740b446683fb133bdd1f3f2c3b0383">ignite::thin::transactions::ClientTransaction::Close</a></div><div class="ttdeci">void Close()</div><div class="ttdoc">Ends the transaction.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:87</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html_a59f9dbbe83fdfda17315dd09e4055d87"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a59f9dbbe83fdfda17315dd09e4055d87">ignite::thin::transactions::ClientTransaction::~ClientTransaction</a></div><div class="ttdeci">~ClientTransaction()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:63</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html_a701fc4d530d868c2c6cbda2ad4e76105"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a701fc4d530d868c2c6cbda2ad4e76105">ignite::thin::transactions::ClientTransaction::ClientTransaction</a></div><div class="ttdeci">ClientTransaction(ignite::impl::thin::transactions::TransactionProxy impl)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:46</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html_a623ba4570863ba9a73164f164a2d64fe"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a623ba4570863ba9a73164f164a2d64fe">ignite::thin::transactions::ClientTransaction::Rollback</a></div><div class="ttdeci">void Rollback()</div><div class="ttdoc">Rolls back this transaction.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:79</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html_a7936e95b0af9a4cf1a134a644f3eaddb"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html#a7936e95b0af9a4cf1a134a644f3eaddb">ignite::thin::transactions::ClientTransaction::Commit</a></div><div class="ttdeci">void Commit()</div><div class="ttdoc">Commits this transaction.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:71</div></div>
<div class="ttc" id="aclassignite_1_1thin_1_1transactions_1_1ClientTransaction_html"><div class="ttname"><a href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html">ignite::thin::transactions::ClientTransaction</a></div><div class="ttdoc">Transaction client.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/transactions/transaction.h:38</div></div>
<!-- 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>