| <!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 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 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&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&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="headertitle"><div class="title">retry_util.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="retry__util_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <chrono></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <type_traits></span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include <utility></span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="macros_8h.html">iceberg/util/macros.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">namespace </span>detail {</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">template</span> <<span class="keyword">typename</span> F></div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="concepticeberg_1_1detail_1_1RetryTask.html"> 41</a></span><span class="keyword">concept </span><a class="code hl_concept" href="concepticeberg_1_1detail_1_1RetryTask.html">RetryTask</a> = <a class="code hl_concept" href="concepticeberg_1_1AsResult.html">AsResult<std::invoke_result_t<F&></a>>;</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>} <span class="comment">// namespace detail</span></div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="foldopen" id="foldopen00046" data-start="{" data-end="};"> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structiceberg_1_1RetryConfig.html"> 46</a></span><span class="keyword">struct </span>ICEBERG_EXPORT <a class="code hl_struct" href="structiceberg_1_1RetryConfig.html">RetryConfig</a> {</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structiceberg_1_1RetryConfig.html#a0d4e08f7e74793956080ddb66c797602"> 48</a></span> int32_t num_retries = 4;</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structiceberg_1_1RetryConfig.html#ae803735b161f9c2eb4478c2b5fa043c4"> 50</a></span> int32_t min_wait_ms = 100;</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structiceberg_1_1RetryConfig.html#a11a1892d24142aaa9fb5385576cb7b81"> 52</a></span> int32_t max_wait_ms = 60 * 1000; <span class="comment">// 1 minute</span></div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="structiceberg_1_1RetryConfig.html#a263c3683a4e87e62f70a256d0eb83f7a"> 54</a></span> int32_t total_timeout_ms = 30 * 60 * 1000; <span class="comment">// 30 minutes</span></div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="structiceberg_1_1RetryConfig.html#a98f14caf3962c28f8a43eaecffcf3bc9"> 56</a></span> <span class="keywordtype">double</span> scale_factor = 2.0;</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div> |
| </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">namespace </span>detail {</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="foldopen" id="foldopen00061" data-start="{" data-end="};"> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classiceberg_1_1detail_1_1RetryRunnerBase.html"> 61</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1detail_1_1RetryRunnerBase.html">RetryRunnerBase</a> {</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1detail_1_1RetryRunnerBase.html">RetryRunnerBase</a>(<a class="code hl_struct" href="structiceberg_1_1RetryConfig.html">RetryConfig</a> config) : config_(std::move(config)) {}</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">using </span>Clock = std::chrono::steady_clock;</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">using </span>Duration = std::chrono::milliseconds;</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">using </span>TimePoint = Clock::time_point;</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classiceberg_1_1detail_1_1RetryRunnerBase.html#a1f30c3527a3d9ca1942c247976ec9dae"> 70</a></span> Status <a class="code hl_function" href="classiceberg_1_1detail_1_1RetryRunnerBase.html#a1f30c3527a3d9ca1942c247976ec9dae">ValidateConfig</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> std::optional<TimePoint> ComputeDeadline() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">bool</span> HasTimedOut(<span class="keyword">const</span> std::optional<TimePoint>& deadline) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> std::optional<Duration> RetryDelayWithinBudget(</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> int32_t attempt, <span class="keyword">const</span> std::optional<TimePoint>& deadline) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">bool</span> WaitForNextAttempt(int32_t attempt,</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">const</span> std::optional<TimePoint>& deadline) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classiceberg_1_1detail_1_1RetryRunnerBase.html#ae12f8a06d8732da3241618b0106349f2"> 78</a></span> int32_t <a class="code hl_function" href="classiceberg_1_1detail_1_1RetryRunnerBase.html#ae12f8a06d8732da3241618b0106349f2">CalculateDelay</a>(int32_t attempt) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_struct" href="structiceberg_1_1RetryConfig.html">RetryConfig</a> config_;</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>};</div> |
| </div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>} <span class="comment">// namespace detail</span></div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="foldopen" id="foldopen00085" data-start="{" data-end="}"> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1retry.html"> 85</a></span><span class="keyword">namespace </span>retry {</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="keyword">enum class</span> RetryPolicyMode {</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> kNoRetry,</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> kOnlyRetryOn,</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> kStopRetryOn,</div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>};</div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">template</span> <RetryPolicyMode Mode, <a class="code hl_enumeration" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">ErrorKind</a>... Kinds></div> |
| <div class="foldopen" id="foldopen00094" data-start="{" data-end="};"> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="structiceberg_1_1retry_1_1RetryPolicy.html"> 94</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a> {</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">static_assert</span>(Mode != RetryPolicyMode::kNoRetry || <span class="keyword">sizeof</span>...(Kinds) == 0,</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="stringliteral">"NoRetry must not include error kinds"</span>);</div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">static_assert</span>(Mode == RetryPolicyMode::kNoRetry || <span class="keyword">sizeof</span>...(Kinds) > 0,</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="stringliteral">"RetryPolicy must include at least one error kind"</span>);</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> RetryPolicyMode kMode = Mode;</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> kEnabled = Mode != RetryPolicyMode::kNoRetry;</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> ShouldRetry(<a class="code hl_enumeration" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">ErrorKind</a> kind) {</div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (Mode == RetryPolicyMode::kNoRetry) {</div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (Mode == RetryPolicyMode::kOnlyRetryOn) {</div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keywordflow">return</span> ((kind == Kinds) || ...);</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> } <span class="keywordflow">else</span> {</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">return</span> !((kind == Kinds) || ...);</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> }</div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> }</div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>};</div> |
| </div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="keyword">using </span><a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">NoRetry</a> = <a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy<RetryPolicyMode::kNoRetry></a>;</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="keyword">template</span> <<a class="code hl_enumeration" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">ErrorKind</a>... Kinds></div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="keyword">using </span><a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">OnlyRetryOn</a> = <a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a><RetryPolicyMode::kOnlyRetryOn, Kinds...>;</div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="keyword">template</span> <<a class="code hl_enumeration" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">ErrorKind</a>... Kinds></div> |
| <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="keyword">using </span><a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">StopRetryOn</a> = <a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a><RetryPolicyMode::kStopRetryOn, Kinds...>;</div> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> kIsRetryPolicy = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keyword">template</span> <RetryPolicyMode Mode, <a class="code hl_enumeration" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">ErrorKind</a>... Kinds></div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> kIsRetryPolicy<<a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">RetryPolicy</a><Mode, Kinds...>> = <span class="keyword">true</span>;</div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div> |
| <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="concepticeberg_1_1retry_1_1Policy.html"> 129</a></span><span class="keyword">concept </span><a class="code hl_concept" href="concepticeberg_1_1retry_1_1Policy.html">Policy</a> = kIsRetryPolicy<std::remove_cvref_t<T>>;</div> |
| <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div> |
| <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>} <span class="comment">// namespace retry</span></div> |
| </div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> </div> |
| <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="keyword">template</span> <retry::Policy RetryPolicy></div> |
| <div class="foldopen" id="foldopen00138" data-start="{" data-end="};"> |
| <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classiceberg_1_1RetryRunner.html"> 138</a></span><span class="keyword">class </span><a class="code hl_class" href="classiceberg_1_1RetryRunner.html">RetryRunner</a> : <span class="keyword">private</span> <a class="code hl_class" href="classiceberg_1_1detail_1_1RetryRunnerBase.html">detail::RetryRunnerBase</a> {</div> |
| <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">public</span>:</div> |
| <div class="foldopen" id="foldopen00141" data-start="{" data-end="}"> |
| <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="classiceberg_1_1RetryRunner.html#a9b118076d50f2d1e1e4a146cc8ade10b"> 141</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classiceberg_1_1RetryRunner.html#a9b118076d50f2d1e1e4a146cc8ade10b">RetryRunner</a>(<a class="code hl_struct" href="structiceberg_1_1RetryConfig.html">RetryConfig</a> config = {})</div> |
| <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> : detail::RetryRunnerBase(<a class="code hl_namespace" href="namespacestd.html">std</a>::move(config)) {}</div> |
| </div> |
| <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div> |
| <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="keyword">template</span> <detail::RetryTask F></div> |
| <div class="foldopen" id="foldopen00150" data-start="{" data-end="}"> |
| <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classiceberg_1_1RetryRunner.html#a65a494c3e49ab9ed72bec7b12fb33e0c"> 150</a></span> <span class="keyword">auto</span> <a class="code hl_function" href="classiceberg_1_1RetryRunner.html#a65a494c3e49ab9ed72bec7b12fb33e0c">Run</a>(F&& task, int32_t* attempt_counter = <span class="keyword">nullptr</span>)</div> |
| <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> -> std::remove_cvref_t<std::invoke_result_t<F&>> {</div> |
| <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> ICEBERG_RETURN_UNEXPECTED(ValidatePolicyConfig());</div> |
| <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div> |
| <div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">const</span> <span class="keyword">auto</span> deadline = this->ComputeDeadline();</div> |
| <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> int32_t attempt = 0;</div> |
| <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> <span class="keyword">const</span> int32_t max_attempts = this->config_.num_retries + 1;</div> |
| <div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> </div> |
| <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <span class="keywordflow">while</span> (<span class="keyword">true</span>) {</div> |
| <div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> ++attempt;</div> |
| <div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <span class="keywordflow">if</span> (attempt_counter != <span class="keyword">nullptr</span>) {</div> |
| <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> *attempt_counter = attempt;</div> |
| <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> }</div> |
| <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> </div> |
| <div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">auto</span> result = std::invoke(task);</div> |
| <div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <span class="keywordflow">if</span> (result.has_value()) {</div> |
| <div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keywordflow">return</span> result;</div> |
| <div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> }</div> |
| <div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div> |
| <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="keywordflow">if</span> (!CanRetry(result.error().kind, attempt, max_attempts, deadline)) {</div> |
| <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> <span class="keywordflow">return</span> result;</div> |
| <div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> }</div> |
| <div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> </div> |
| <div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="keywordflow">if</span> (!this->WaitForNextAttempt(attempt, deadline)) {</div> |
| <div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordflow">return</span> result;</div> |
| <div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> }</div> |
| <div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> }</div> |
| <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> }</div> |
| </div> |
| <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> </div> |
| <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="keyword">using </span>TimePoint = detail::RetryRunnerBase::TimePoint;</div> |
| <div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div> |
| <div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> Status ValidatePolicyConfig()<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">auto</span> validation = this-><a class="code hl_function" href="classiceberg_1_1detail_1_1RetryRunnerBase.html#a1f30c3527a3d9ca1942c247976ec9dae">ValidateConfig</a>();</div> |
| <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="keywordflow">if</span> (!validation.has_value()) {</div> |
| <div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <span class="keywordflow">return</span> validation;</div> |
| <div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> }</div> |
| <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keywordflow">if</span> (this->config_.num_retries > 0 && !RetryPolicy::kEnabled) {</div> |
| <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordflow">return</span> InvalidArgument(<span class="stringliteral">"Retry policy must be enabled when num_retries > 0"</span>);</div> |
| <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> }</div> |
| <div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> <span class="keywordflow">return</span> {};</div> |
| <div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> }</div> |
| <div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> </div> |
| <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> <span class="keywordtype">bool</span> CanRetry(<a class="code hl_enumeration" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">ErrorKind</a> kind, int32_t attempt, int32_t max_attempts,</div> |
| <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keyword">const</span> std::optional<TimePoint>& deadline)<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> <span class="keywordflow">return</span> attempt < max_attempts && !this->HasTimedOut(deadline) &&</div> |
| <div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> RetryPolicy::ShouldRetry(kind);</div> |
| <div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> }</div> |
| <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span>};</div> |
| </div> |
| <div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> </div> |
| <div class="foldopen" id="foldopen00201" data-start="{" data-end="}"> |
| <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"><a class="line" href="namespaceiceberg.html#a5408ff5caa8e62fc64370d1e4adfa6e0"> 201</a></span>ICEBERG_EXPORT <span class="keyword">inline</span> <span class="keyword">auto</span> <a class="code hl_function" href="namespaceiceberg.html#a5408ff5caa8e62fc64370d1e4adfa6e0">MakeCommitRetryRunner</a>(int32_t num_retries, int32_t min_wait_ms,</div> |
| <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> int32_t max_wait_ms,</div> |
| <div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> int32_t total_timeout_ms) {</div> |
| <div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classiceberg_1_1RetryRunner.html">RetryRunner</a><<a class="code hl_struct" href="structiceberg_1_1retry_1_1RetryPolicy.html">retry::OnlyRetryOn</a><ErrorKind::kCommitFailed,</div> |
| <div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> ErrorKind::kRetryableValidationFailed>>(</div> |
| <div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <a class="code hl_struct" href="structiceberg_1_1RetryConfig.html">RetryConfig</a>{.<a class="code hl_variable" href="structiceberg_1_1RetryConfig.html#a0d4e08f7e74793956080ddb66c797602">num_retries</a> = num_retries,</div> |
| <div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> .min_wait_ms = min_wait_ms,</div> |
| <div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> .max_wait_ms = max_wait_ms,</div> |
| <div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> .total_timeout_ms = total_timeout_ms});</div> |
| <div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span>}</div> |
| </div> |
| <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> </div> |
| <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1RetryRunner_html"><div class="ttname"><a href="classiceberg_1_1RetryRunner.html">iceberg::RetryRunner</a></div><div class="ttdoc">Utility class for running tasks with retry logic.</div><div class="ttdef"><b>Definition</b> retry_util.h:138</div></div> |
| <div class="ttc" id="aclassiceberg_1_1RetryRunner_html_a65a494c3e49ab9ed72bec7b12fb33e0c"><div class="ttname"><a href="classiceberg_1_1RetryRunner.html#a65a494c3e49ab9ed72bec7b12fb33e0c">iceberg::RetryRunner::Run</a></div><div class="ttdeci">auto Run(F &&task, int32_t *attempt_counter=nullptr) -> std::remove_cvref_t< std::invoke_result_t< F & > ></div><div class="ttdoc">Run a task that returns a Result<T></div><div class="ttdef"><b>Definition</b> retry_util.h:150</div></div> |
| <div class="ttc" id="aclassiceberg_1_1RetryRunner_html_a9b118076d50f2d1e1e4a146cc8ade10b"><div class="ttname"><a href="classiceberg_1_1RetryRunner.html#a9b118076d50f2d1e1e4a146cc8ade10b">iceberg::RetryRunner::RetryRunner</a></div><div class="ttdeci">RetryRunner(RetryConfig config={})</div><div class="ttdoc">Construct a RetryRunner with the given configuration.</div><div class="ttdef"><b>Definition</b> retry_util.h:141</div></div> |
| <div class="ttc" id="aclassiceberg_1_1detail_1_1RetryRunnerBase_html"><div class="ttname"><a href="classiceberg_1_1detail_1_1RetryRunnerBase.html">iceberg::detail::RetryRunnerBase</a></div><div class="ttdef"><b>Definition</b> retry_util.h:61</div></div> |
| <div class="ttc" id="aclassiceberg_1_1detail_1_1RetryRunnerBase_html_a1f30c3527a3d9ca1942c247976ec9dae"><div class="ttname"><a href="classiceberg_1_1detail_1_1RetryRunnerBase.html#a1f30c3527a3d9ca1942c247976ec9dae">iceberg::detail::RetryRunnerBase::ValidateConfig</a></div><div class="ttdeci">Status ValidateConfig() const</div><div class="ttdoc">Validate retry counts and timing bounds.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1detail_1_1RetryRunnerBase_html_ae12f8a06d8732da3241618b0106349f2"><div class="ttname"><a href="classiceberg_1_1detail_1_1RetryRunnerBase.html#ae12f8a06d8732da3241618b0106349f2">iceberg::detail::RetryRunnerBase::CalculateDelay</a></div><div class="ttdeci">int32_t CalculateDelay(int32_t attempt) const</div><div class="ttdoc">Calculate delay with exponential backoff and jitter.</div></div> |
| <div class="ttc" id="aconcepticeberg_1_1AsResult_html"><div class="ttname"><a href="concepticeberg_1_1AsResult.html">iceberg::AsResult</a></div><div class="ttdef"><b>Definition</b> result.h:143</div></div> |
| <div class="ttc" id="aconcepticeberg_1_1detail_1_1RetryTask_html"><div class="ttname"><a href="concepticeberg_1_1detail_1_1RetryTask.html">iceberg::detail::RetryTask</a></div><div class="ttdef"><b>Definition</b> retry_util.h:41</div></div> |
| <div class="ttc" id="aconcepticeberg_1_1retry_1_1Policy_html"><div class="ttname"><a href="concepticeberg_1_1retry_1_1Policy.html">iceberg::retry::Policy</a></div><div class="ttdef"><b>Definition</b> retry_util.h:129</div></div> |
| <div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="amacros_8h_html"><div class="ttname"><a href="macros_8h.html">macros.h</a></div><div class="ttdoc">Define common Iceberg utility macros.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a5408ff5caa8e62fc64370d1e4adfa6e0"><div class="ttname"><a href="namespaceiceberg.html#a5408ff5caa8e62fc64370d1e4adfa6e0">iceberg::MakeCommitRetryRunner</a></div><div class="ttdeci">ICEBERG_EXPORT auto MakeCommitRetryRunner(int32_t num_retries, int32_t min_wait_ms, int32_t max_wait_ms, int32_t total_timeout_ms)</div><div class="ttdoc">Helper function to create a RetryRunner with table commit configuration.</div><div class="ttdef"><b>Definition</b> retry_util.h:201</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a5cf8d9de1acce830ff4fc3d87fe95147"><div class="ttname"><a href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">iceberg::ErrorKind</a></div><div class="ttdeci">ErrorKind</div><div class="ttdoc">Error types for iceberg.</div><div class="ttdef"><b>Definition</b> result.h:36</div></div> |
| <div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructiceberg_1_1RetryConfig_html"><div class="ttname"><a href="structiceberg_1_1RetryConfig.html">iceberg::RetryConfig</a></div><div class="ttdoc">Configuration for retry behavior.</div><div class="ttdef"><b>Definition</b> retry_util.h:46</div></div> |
| <div class="ttc" id="astructiceberg_1_1RetryConfig_html_a0d4e08f7e74793956080ddb66c797602"><div class="ttname"><a href="structiceberg_1_1RetryConfig.html#a0d4e08f7e74793956080ddb66c797602">iceberg::RetryConfig::num_retries</a></div><div class="ttdeci">int32_t num_retries</div><div class="ttdoc">Maximum number of retry attempts (not including the first attempt)</div><div class="ttdef"><b>Definition</b> retry_util.h:48</div></div> |
| <div class="ttc" id="astructiceberg_1_1retry_1_1RetryPolicy_html"><div class="ttname"><a href="structiceberg_1_1retry_1_1RetryPolicy.html">iceberg::retry::RetryPolicy</a></div><div class="ttdef"><b>Definition</b> retry_util.h:94</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
