blob: 8500fb48eb46d931917eeb9fb4c5b4631e09bfaf [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>
<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(72949126, "init", {
clickmap:true,
trackLinks:true,
accurateTrackBounce:true,
webvisor:true
});
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->
<script type='text/javascript'>
window.__lo_site_id = 284467;
(function() {
var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
})();
</script>
<link rel="canonical" href="https://ignite.apache.org/releases/latest/cppdoc/classignite_1_1thin_1_1transactions_1_1ClientTransactions.html" />
<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::ClientTransactions 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" />
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-61232409-1');
</script></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_1ClientTransactions.html">ClientTransactions</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_1ClientTransactions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::thin::transactions::ClientTransactions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Transactions client.
<a href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="thin-client_2include_2ignite_2thin_2transactions_2transactions_8h_source.html">transactions.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:a000c6b028d0a94c517ea2a13498e5d02"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#a000c6b028d0a94c517ea2a13498e5d02">ClientTransactions</a> (ignite::common::concurrent::SharedPointer&lt; void &gt; impl)</td></tr>
<tr class="memdesc:a000c6b028d0a94c517ea2a13498e5d02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a000c6b028d0a94c517ea2a13498e5d02">More...</a><br /></td></tr>
<tr class="separator:a000c6b028d0a94c517ea2a13498e5d02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a667baeaf942df30ef91ecb46f8287fa8"><td class="memItemLeft" align="right" valign="top"><a id="a667baeaf942df30ef91ecb46f8287fa8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#a667baeaf942df30ef91ecb46f8287fa8">ClientTransactions</a> ()</td></tr>
<tr class="memdesc:a667baeaf942df30ef91ecb46f8287fa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a667baeaf942df30ef91ecb46f8287fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f1456d003c59183adcc98c37dbf5ff1"><td class="memItemLeft" align="right" valign="top"><a id="a8f1456d003c59183adcc98c37dbf5ff1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#a8f1456d003c59183adcc98c37dbf5ff1">~ClientTransactions</a> ()</td></tr>
<tr class="memdesc:a8f1456d003c59183adcc98c37dbf5ff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a8f1456d003c59183adcc98c37dbf5ff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38383921a9f5eec9144ff5a4f0eed612"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html">ClientTransaction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#a38383921a9f5eec9144ff5a4f0eed612">TxStart</a> (<a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionConcurrency.html#a73c4c86e44cf441df006c8e242ac3fdd">TransactionConcurrency::Type</a> concurrency=<a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionConcurrency.html#a73c4c86e44cf441df006c8e242ac3fdda43f370006a8d920c4783eddef1975a9b">TransactionConcurrency::PESSIMISTIC</a>, <a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionIsolation.html#a469b243892db2781f60f5c3f79b4ed75">TransactionIsolation::Type</a> isolation=<a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionIsolation.html#a469b243892db2781f60f5c3f79b4ed75aa3e0e30cfc972ff0ec578f56ee194c54">TransactionIsolation::READ_COMMITTED</a>, int64_t timeout=0, int32_t txSize=0)</td></tr>
<tr class="memdesc:a38383921a9f5eec9144ff5a4f0eed612"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start new transaction with completely clarify parameters. <a href="#a38383921a9f5eec9144ff5a4f0eed612">More...</a><br /></td></tr>
<tr class="separator:a38383921a9f5eec9144ff5a4f0eed612"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31cf4f4a73bc5a548c1c1279249330a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html">ClientTransactions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#a31cf4f4a73bc5a548c1c1279249330a5">withLabel</a> (const std::string &amp;lbl)</td></tr>
<tr class="memdesc:a31cf4f4a73bc5a548c1c1279249330a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns instance of. <a href="#a31cf4f4a73bc5a548c1c1279249330a5">More...</a><br /></td></tr>
<tr class="separator:a31cf4f4a73bc5a548c1c1279249330a5"><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>Transactions client. </p>
<p>This is an entry point for Thin C++ <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> transactions.</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="a000c6b028d0a94c517ea2a13498e5d02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a000c6b028d0a94c517ea2a13498e5d02">&#9670;&nbsp;</a></span>ClientTransactions()</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::ClientTransactions::ClientTransactions </td>
<td>(</td>
<td class="paramtype">ignite::common::concurrent::SharedPointer&lt; void &gt;&#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="a38383921a9f5eec9144ff5a4f0eed612"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38383921a9f5eec9144ff5a4f0eed612">&#9670;&nbsp;</a></span>TxStart()</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="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html">ClientTransaction</a> ignite::thin::transactions::ClientTransactions::TxStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionConcurrency.html#a73c4c86e44cf441df006c8e242ac3fdd">TransactionConcurrency::Type</a>&#160;</td>
<td class="paramname"><em>concurrency</em> = <code><a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionConcurrency.html#a73c4c86e44cf441df006c8e242ac3fdda43f370006a8d920c4783eddef1975a9b">TransactionConcurrency::PESSIMISTIC</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionIsolation.html#a469b243892db2781f60f5c3f79b4ed75">TransactionIsolation::Type</a>&#160;</td>
<td class="paramname"><em>isolation</em> = <code><a class="el" href="structignite_1_1thin_1_1transactions_1_1TransactionIsolation.html#a469b243892db2781f60f5c3f79b4ed75aa3e0e30cfc972ff0ec578f56ee194c54">TransactionIsolation::READ_COMMITTED</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>timeout</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>txSize</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Start new transaction with completely clarify parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">concurrency</td><td>Transaction concurrency. </td></tr>
<tr><td class="paramname">isolation</td><td>Transaction isolation. </td></tr>
<tr><td class="paramname">timeout</td><td>Transaction timeout. </td></tr>
<tr><td class="paramname">txSize</td><td>Number of entries participating in transaction (may be approximate).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransaction.html" title="Transaction client. ">ClientTransaction</a> implementation. </dd></dl>
</div>
</div>
<a id="a31cf4f4a73bc5a548c1c1279249330a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31cf4f4a73bc5a548c1c1279249330a5">&#9670;&nbsp;</a></span>withLabel()</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="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html">ClientTransactions</a> ignite::thin::transactions::ClientTransactions::withLabel </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>lbl</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>Returns instance of. </p>
<div class="fragment"><div class="line"><a class="code" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html#a667baeaf942df30ef91ecb46f8287fa8">ClientTransactions</a> </div></div><!-- fragment --><p> to mark each new transaction with a specified label.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">label</td><td>Transaction label. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classignite_1_1thin_1_1transactions_1_1ClientTransactions.html" title="Transactions client. ">ClientTransactions</a> implementation. </dd></dl>
</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_2transactions_8h_source.html">thin-client/include/ignite/thin/transactions/transactions.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>