| <!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/catalog/rest/auth/token_refresh_scheduler.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_a7beda0dac529a54d3cdf90e787bdce7.html">catalog</a></li><li class="navelem"><a class="el" href="dir_08d6efe6feae927f0fa1ad794a1878b0.html">rest</a></li><li class="navelem"><a class="el" href="dir_2148276f9150a57285320fbe9f3c6738.html">auth</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">token_refresh_scheduler.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="token__refresh__scheduler_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="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <chrono></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <condition_variable></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <mutex></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <thread></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="iceberg__rest__export_8h.html">iceberg/catalog/rest/iceberg_rest_export.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg_1_1rest_1_1auth.html">iceberg::rest::auth</a> {</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="foldopen" id="foldopen00047" data-start="{" data-end="};"> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html"> 47</a></span><span class="keyword">class </span>ICEBERG_REST_EXPORT <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a> {</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a7ee284b76cb67a61803cdfd5552b2c9f"> 54</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>& <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a7ee284b76cb67a61803cdfd5552b2c9f">Instance</a>();</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a1fbe3cca9a30faca076d92dd8fdf5892"> 61</a></span> uint64_t <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a1fbe3cca9a30faca076d92dd8fdf5892">Schedule</a>(std::chrono::milliseconds delay, std::function<<span class="keywordtype">void</span>()> callback);</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#aca19f17b23d0856e91a0f2e3bcda199d"> 68</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#aca19f17b23d0856e91a0f2e3bcda199d">Cancel</a>(uint64_t handle);</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#ad06e6355dba76b033df41616e62cf777"> 78</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#ad06e6355dba76b033df41616e62cf777">Shutdown</a>();</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_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">~TokenRefreshScheduler</a>();</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">// Non-copyable, non-movable</span></div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>(<a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>&&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>& operator=(<a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">TokenRefreshScheduler</a>&&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a6a5eb72b84bb76c944c7a27c530ffdeb"> 92</a></span> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a6a5eb72b84bb76c944c7a27c530ffdeb">TokenRefreshScheduler</a>();</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">void</span> Run();</div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">struct </span>Task {</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> uint64_t id;</div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> std::chrono::steady_clock::time_point fire_at;</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> std::function<void()> callback;</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> </div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> std::mutex mutex_;</div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> std::condition_variable cv_;</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> std::vector<Task> tasks_;</div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> uint64_t next_id_ = 1; <span class="comment">// 0 is reserved as "invalid handle"</span></div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">bool</span> shutdown_ = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> std::thread worker_;</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>};</div> |
| </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>} <span class="comment">// namespace iceberg::rest::auth</span></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler_html"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html">iceberg::rest::auth::TokenRefreshScheduler</a></div><div class="ttdoc">A process-global scheduler for delayed token refresh tasks.</div><div class="ttdef"><b>Definition</b> token_refresh_scheduler.h:47</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler_html_a1fbe3cca9a30faca076d92dd8fdf5892"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a1fbe3cca9a30faca076d92dd8fdf5892">iceberg::rest::auth::TokenRefreshScheduler::Schedule</a></div><div class="ttdeci">uint64_t Schedule(std::chrono::milliseconds delay, std::function< void()> callback)</div><div class="ttdoc">Schedule a callback to run after a delay.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler_html_a6a5eb72b84bb76c944c7a27c530ffdeb"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a6a5eb72b84bb76c944c7a27c530ffdeb">iceberg::rest::auth::TokenRefreshScheduler::TokenRefreshScheduler</a></div><div class="ttdeci">TokenRefreshScheduler()</div><div class="ttdoc">Construct a scheduler (prefer Instance() for production use).</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler_html_a7ee284b76cb67a61803cdfd5552b2c9f"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#a7ee284b76cb67a61803cdfd5552b2c9f">iceberg::rest::auth::TokenRefreshScheduler::Instance</a></div><div class="ttdeci">static TokenRefreshScheduler & Instance()</div><div class="ttdoc">Get the global singleton instance.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler_html_aca19f17b23d0856e91a0f2e3bcda199d"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#aca19f17b23d0856e91a0f2e3bcda199d">iceberg::rest::auth::TokenRefreshScheduler::Cancel</a></div><div class="ttdeci">void Cancel(uint64_t handle)</div><div class="ttdoc">Cancel a previously scheduled task.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler_html_ad06e6355dba76b033df41616e62cf777"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1TokenRefreshScheduler.html#ad06e6355dba76b033df41616e62cf777">iceberg::rest::auth::TokenRefreshScheduler::Shutdown</a></div><div class="ttdeci">void Shutdown()</div><div class="ttdoc">Shutdown the scheduler, cancelling all pending tasks.</div></div> |
| <div class="ttc" id="aiceberg__rest__export_8h_html"><div class="ttname"><a href="iceberg__rest__export_8h.html">iceberg_rest_export.h</a></div><div class="ttdoc">Define symbol visibility macros for the REST catalog library.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_1_1auth_html"><div class="ttname"><a href="namespaceiceberg_1_1rest_1_1auth.html">iceberg::rest::auth</a></div><div class="ttdoc">REST catalog authentication APIs.</div><div class="ttdef"><b>Definition</b> auth_manager.h:34</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> |
