Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/retry__util_8h.html
blob: eed321777d0419023e5f6c3eb98c7b22a733b40b [file]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg/util/retry_util.h File 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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_6a066966226cd78a6111c1015733de08.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">retry_util.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provide retry policy and runner utilities.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;chrono&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;functional&gt;</code><br />
<code>#include &lt;optional&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="macros_8h_source.html">iceberg/util/macros.h</a>&quot;</code><br />
</div>
<p><a href="retry__util_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1RetryConfig.html">iceberg::RetryConfig</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration for retry behavior. <a href="structiceberg_1_1RetryConfig.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1detail_1_1RetryRunnerBase.html">iceberg::detail::RetryRunnerBase</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1retry_1_1RetryPolicy.html">iceberg::retry::RetryPolicy&lt; Mode, Kinds &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1RetryRunner.html">iceberg::RetryRunner&lt; RetryPolicy &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility class for running tasks with retry logic. <a href="classiceberg_1_1RetryRunner.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceiceberg_1_1retry" id="r_namespaceiceberg_1_1retry"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1retry.html">iceberg::retry</a></td></tr>
<tr class="memdesc:namespaceiceberg_1_1retry"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retry policy APIs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concepticeberg_1_1detail_1_1RetryTask.html">iceberg::detail::RetryTask</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concepticeberg_1_1retry_1_1Policy.html">iceberg::retry::Policy</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a2045c82b4d25fc5d555689ba5277d2ed" id="r_a2045c82b4d25fc5d555689ba5277d2ed"><td class="memItemLeft" align="right" valign="top"><a id="a2045c82b4d25fc5d555689ba5277d2ed" name="a2045c82b4d25fc5d555689ba5277d2ed"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::retry::NoRetry</b> = <a class="el" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a>&lt; RetryPolicyMode::kNoRetry &gt;</td></tr>
<tr class="separator:a2045c82b4d25fc5d555689ba5277d2ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08d6fd6ac96bab005ae592ffb3da6ed1" id="r_a08d6fd6ac96bab005ae592ffb3da6ed1"><td class="memTemplParams" colspan="2"><a id="a08d6fd6ac96bab005ae592ffb3da6ed1" name="a08d6fd6ac96bab005ae592ffb3da6ed1"></a>
template&lt;ErrorKind... Kinds&gt; </td></tr>
<tr class="memitem:a08d6fd6ac96bab005ae592ffb3da6ed1"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::retry::OnlyRetryOn</b> = <a class="el" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a>&lt; RetryPolicyMode::kOnlyRetryOn, Kinds... &gt;</td></tr>
<tr class="separator:a08d6fd6ac96bab005ae592ffb3da6ed1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa75a81fb2715f2eeaed91852fc859fcf" id="r_aa75a81fb2715f2eeaed91852fc859fcf"><td class="memTemplParams" colspan="2"><a id="aa75a81fb2715f2eeaed91852fc859fcf" name="aa75a81fb2715f2eeaed91852fc859fcf"></a>
template&lt;ErrorKind... Kinds&gt; </td></tr>
<tr class="memitem:aa75a81fb2715f2eeaed91852fc859fcf"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::retry::StopRetryOn</b> = <a class="el" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a>&lt; RetryPolicyMode::kStopRetryOn, Kinds... &gt;</td></tr>
<tr class="separator:aa75a81fb2715f2eeaed91852fc859fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a7914952f216f906a39cbd4b3688ed6f4" id="r_a7914952f216f906a39cbd4b3688ed6f4"><td class="memItemLeft" align="right" valign="top"><a id="a7914952f216f906a39cbd4b3688ed6f4" name="a7914952f216f906a39cbd4b3688ed6f4"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>RetryPolicyMode</b> { <b>kNoRetry</b>
, <b>kOnlyRetryOn</b>
, <b>kStopRetryOn</b>
}</td></tr>
<tr class="separator:a7914952f216f906a39cbd4b3688ed6f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5408ff5caa8e62fc64370d1e4adfa6e0" id="r_a5408ff5caa8e62fc64370d1e4adfa6e0"><td class="memItemLeft" align="right" valign="top"><a id="a5408ff5caa8e62fc64370d1e4adfa6e0" name="a5408ff5caa8e62fc64370d1e4adfa6e0"></a>
ICEBERG_EXPORT auto&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::MakeCommitRetryRunner</b> (int32_t num_retries, int32_t min_wait_ms, int32_t max_wait_ms, int32_t total_timeout_ms)</td></tr>
<tr class="memdesc:a5408ff5caa8e62fc64370d1e4adfa6e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function to create a <a class="el" href="classiceberg_1_1RetryRunner.html" title="Utility class for running tasks with retry logic.">RetryRunner</a> with table commit configuration. <br /></td></tr>
<tr class="separator:a5408ff5caa8e62fc64370d1e4adfa6e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a364de74b4e71c798eb8f7870e62306f8" id="r_a364de74b4e71c798eb8f7870e62306f8"><td class="memTemplParams" colspan="2"><a id="a364de74b4e71c798eb8f7870e62306f8" name="a364de74b4e71c798eb8f7870e62306f8"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a364de74b4e71c798eb8f7870e62306f8"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::retry::kIsRetryPolicy</b> = false</td></tr>
<tr class="separator:a364de74b4e71c798eb8f7870e62306f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40fad00cf40394febd99734ef49c2aaa" id="r_a40fad00cf40394febd99734ef49c2aaa"><td class="memTemplParams" colspan="2"><a id="a40fad00cf40394febd99734ef49c2aaa" name="a40fad00cf40394febd99734ef49c2aaa"></a>
template&lt;RetryPolicyMode Mode, ErrorKind... Kinds&gt; </td></tr>
<tr class="memitem:a40fad00cf40394febd99734ef49c2aaa"><td class="memTemplItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::retry::kIsRetryPolicy&lt; RetryPolicy&lt; Mode, Kinds... &gt; &gt;</b> = true</td></tr>
<tr class="separator:a40fad00cf40394febd99734ef49c2aaa"><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>Provide retry policy and runner utilities. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>