diff options
Diffstat (limited to 'deadline_8h.html')
| -rw-r--r-- | deadline_8h.html | 204 |
1 files changed, 188 insertions, 16 deletions
diff --git a/deadline_8h.html b/deadline_8h.html index d9d9116f..83fe3e3e 100644 --- a/deadline_8h.html +++ b/deadline_8h.html @@ -1,9 +1,9 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!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.13"/> +<meta name="generator" content="Doxygen 1.8.17"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>LLFIO: include/llfio/v2.0/deadline.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -13,9 +13,6 @@ <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); -</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> @@ -29,7 +26,7 @@ <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">LLFIO -  <span id="projectnumber">v2.00 late alpha</span> +  <span id="projectnumber">v2.00 late beta</span> </div> </td> </tr> @@ -37,18 +34,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -62,7 +62,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('deadline_8h.html','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('deadline_8h.html',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -88,9 +90,6 @@ $(document).ready(function(){initNavTree('deadline_8h.html','');}); <div class="title">deadline.h File Reference</div> </div> </div><!--header--> <div class="contents"> - -<p>Provides struct deadline. -<a href="#details">More...</a></p> <div class="textblock"><code>#include <stdbool.h></code><br /> <code>#include <time.h></code><br /> <code>#include "<a class="el" href="config_8hpp.html">config.hpp</a>"</code><br /> @@ -113,11 +112,22 @@ Macros</h2></td></tr> <tr class="memitem:a8248d979e402cb0538f7f6f2840b55c1"><td class="memItemLeft" align="right" valign="top"><a id="a8248d979e402cb0538f7f6f2840b55c1"></a> #define </td><td class="memItemRight" valign="bottom"><b>LLFIO_DEADLINE_NAME</b>   deadline</td></tr> <tr class="separator:a8248d979e402cb0538f7f6f2840b55c1"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9ad4e75918453ebe2365378d3d04dce0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>LLFIO_DEADLINE_TO_PARTIAL_DEADLINE</b>(nd, d)</td></tr> +<tr class="memitem:adf76463290984016fdbe2ac4c7c514e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="deadline_8h.html#adf76463290984016fdbe2ac4c7c514e4">LLFIO_DEADLINE_TO_SLEEP_INIT</a>(d)</td></tr> +<tr class="separator:adf76463290984016fdbe2ac4c7c514e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9ad4e75918453ebe2365378d3d04dce0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="deadline_8h.html#a9ad4e75918453ebe2365378d3d04dce0">LLFIO_DEADLINE_TO_PARTIAL_DEADLINE</a>(nd, d)</td></tr> +<tr class="memdesc:a9ad4e75918453ebe2365378d3d04dce0"><td class="mdescLeft"> </td><td class="mdescRight">Run inside a series of steps to create a sub-deadline from a master deadline. <a href="deadline_8h.html#a9ad4e75918453ebe2365378d3d04dce0">More...</a><br /></td></tr> <tr class="separator:a9ad4e75918453ebe2365378d3d04dce0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a93c83aa94fad67aa1289d8a2b2d6ed00"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="deadline_8h.html#a93c83aa94fad67aa1289d8a2b2d6ed00">LLFIO_DEADLINE_TO_PARTIAL_TIMEOUT</a>(timeout, d)</td></tr> +<tr class="memdesc:a93c83aa94fad67aa1289d8a2b2d6ed00"><td class="mdescLeft"> </td><td class="mdescRight">Run inside a series of steps to create a relative timeout from now from a master deadline. <a href="deadline_8h.html#a93c83aa94fad67aa1289d8a2b2d6ed00">More...</a><br /></td></tr> +<tr class="separator:a93c83aa94fad67aa1289d8a2b2d6ed00"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:add774fdf81fd7e573d42a43fe55757ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="deadline_8h.html#add774fdf81fd7e573d42a43fe55757ba">LLFIO_DEADLINE_TO_TIMEOUT_LOOP</a>(d)</td></tr> +<tr class="memdesc:add774fdf81fd7e573d42a43fe55757ba"><td class="mdescLeft"> </td><td class="mdescRight">Run inside a loop to detect if the operation has timed out. <a href="deadline_8h.html#add774fdf81fd7e573d42a43fe55757ba">More...</a><br /></td></tr> +<tr class="separator:add774fdf81fd7e573d42a43fe55757ba"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa829fa57d8fc5156dd4358b670cd7c56"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>LLFIO_DEADLINE_TRY_FOR_UNTIL</b>(name)</td></tr> +<tr class="separator:aa829fa57d8fc5156dd4358b670cd7c56"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Provides struct deadline. </p> +<div class="textblock"><p>Provides struct deadline </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="a9ad4e75918453ebe2365378d3d04dce0"></a> <h2 class="memtitle"><span class="permalink"><a href="#a9ad4e75918453ebe2365378d3d04dce0">◆ </a></span>LLFIO_DEADLINE_TO_PARTIAL_DEADLINE</h2> @@ -144,7 +154,169 @@ Macros</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">if</span>(d) \</div><div class="line"> { \</div><div class="line"> if((d).steady) \</div><div class="line"> { \</div><div class="line"> (nd).steady = <span class="keyword">true</span>; \</div><div class="line"> std::chrono::nanoseconds ns = std::chrono::duration_cast<std::chrono::nanoseconds>((began_steady + std::chrono::nanoseconds((d).nsecs)) - std::chrono::steady_clock::now()); \</div><div class="line"> if(ns.count() < 0) \</div><div class="line"> (nd).nsecs = 0; \</div><div class="line"> else \</div><div class="line"> (nd).nsecs = ns.count(); \</div><div class="line"> } \</div><div class="line"> else \</div><div class="line"> (nd) = (d); \</div><div class="line"> }</div></div><!-- fragment --> +<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span>(d) \</div> +<div class="line"> { \</div> +<div class="line"> if((d).steady) \</div> +<div class="line"> { \</div> +<div class="line"> (nd).steady = <span class="keyword">true</span>; \</div> +<div class="line"> std::chrono::nanoseconds ns = \</div> +<div class="line"> ((d).nsecs != 0) ? \</div> +<div class="line"> std::chrono::duration_cast<std::chrono::nanoseconds>((began_steady + std::chrono::nanoseconds((d).nsecs)) - std::chrono::steady_clock::now()) : \</div> +<div class="line"> std::chrono::nanoseconds(0); \</div> +<div class="line"> if(ns.count() < 0) \</div> +<div class="line"> (nd).nsecs = 0; \</div> +<div class="line"> else \</div> +<div class="line"> (nd).nsecs = ns.count(); \</div> +<div class="line"> } \</div> +<div class="line"> else \</div> +<div class="line"> (nd) = (d); \</div> +<div class="line"> }</div> +</div><!-- fragment --> +<p>Run inside a series of steps to create a sub-deadline from a master deadline. </p> + +</div> +</div> +<a id="a93c83aa94fad67aa1289d8a2b2d6ed00"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a93c83aa94fad67aa1289d8a2b2d6ed00">◆ </a></span>LLFIO_DEADLINE_TO_PARTIAL_TIMEOUT</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define LLFIO_DEADLINE_TO_PARTIAL_TIMEOUT</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">timeout, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname">d </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<b>Value:</b><div class="fragment"><div class="line"> { \</div> +<div class="line"> using timeout_type = std::decay_t<decltype(timeout)>; \</div> +<div class="line"> timeout = timeout_type(); \</div> +<div class="line"> if(d) \</div> +<div class="line"> { \</div> +<div class="line"> if((d).steady) \</div> +<div class="line"> { \</div> +<div class="line"> timeout = ((d).nsecs != 0) ? \</div> +<div class="line"> std::chrono::duration_cast<timeout_type>((began_steady + std::chrono::nanoseconds((d).nsecs)) - std::chrono::steady_clock::now()) : \</div> +<div class="line"> timeout_type(0); \</div> +<div class="line"> } \</div> +<div class="line"> else \</div> +<div class="line"> timeout = std::chrono::duration_cast<timeout_type>(d.to_time_point() - std::chrono::system_clock::now()); \</div> +<div class="line"> if(timeout.count() < 0) \</div> +<div class="line"> timeout = timeout_type(0); \</div> +<div class="line"> } \</div> +<div class="line"> }</div> +</div><!-- fragment --> +<p>Run inside a series of steps to create a relative timeout from now from a master deadline. </p> + +</div> +</div> +<a id="adf76463290984016fdbe2ac4c7c514e4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adf76463290984016fdbe2ac4c7c514e4">◆ </a></span>LLFIO_DEADLINE_TO_SLEEP_INIT</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define LLFIO_DEADLINE_TO_SLEEP_INIT</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">d</td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<b>Value:</b><div class="fragment"><div class="line"> std::chrono::steady_clock::time_point began_steady; \</div> +<div class="line"> if(d) \</div> +<div class="line"> { \</div> +<div class="line"> if((d).steady && (d).nsecs != 0) \</div> +<div class="line"> began_steady = std::chrono::steady_clock::now(); \</div> +<div class="line"> }</div> +</div><!-- fragment --><p>Defines a number of variables into its scope:</p> +<ul> +<li>began_steady: Set to the steady clock at the beginning of a sleep </li> +</ul> + +</div> +</div> +<a id="add774fdf81fd7e573d42a43fe55757ba"></a> +<h2 class="memtitle"><span class="permalink"><a href="#add774fdf81fd7e573d42a43fe55757ba">◆ </a></span>LLFIO_DEADLINE_TO_TIMEOUT_LOOP</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define LLFIO_DEADLINE_TO_TIMEOUT_LOOP</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">d</td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span>(d) \</div> +<div class="line"> { \</div> +<div class="line"> if((d).steady) \</div> +<div class="line"> { \</div> +<div class="line"> if((d).nsecs == 0 || std::chrono::steady_clock::now() >= (began_steady + std::chrono::nanoseconds((d).nsecs))) \</div> +<div class="line"> return LLFIO_V2_NAMESPACE::failure(LLFIO_V2_NAMESPACE::errc::timed_out); \</div> +<div class="line"> } \</div> +<div class="line"> else \</div> +<div class="line"> { \</div> +<div class="line"> LLFIO_V2_NAMESPACE::deadline now(std::chrono::system_clock::now()); \</div> +<div class="line"> if(now.utc.tv_sec > (d).utc.tv_sec || (now.utc.tv_sec == (d).utc.tv_sec && now.utc.tv_nsec >= (d).utc.tv_nsec)) \</div> +<div class="line"> return LLFIO_V2_NAMESPACE::failure(LLFIO_V2_NAMESPACE::errc::timed_out); \</div> +<div class="line"> } \</div> +<div class="line"> }</div> +</div><!-- fragment --> +<p>Run inside a loop to detect if the operation has timed out. </p> + +</div> +</div> +<a id="aa829fa57d8fc5156dd4358b670cd7c56"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa829fa57d8fc5156dd4358b670cd7c56">◆ </a></span>LLFIO_DEADLINE_TRY_FOR_UNTIL</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define LLFIO_DEADLINE_TRY_FOR_UNTIL</td> + <td>(</td> + <td class="paramtype"> </td> + <td class="paramname">name</td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">template</span> <<span class="keyword">class</span>... Args> <span class="keywordtype">bool</span> try_##name(Args &&... args) noexcept \</div> +<div class="line"> { \</div> +<div class="line"> auto r = name(std::forward<Args>(args)..., std::chrono::seconds(0)); \</div> +<div class="line"> return !!r; \</div> +<div class="line"> } \</div> +<div class="line"> template <<span class="keyword">class</span>... Args, <span class="keyword">class </span>Rep, class Period> bool try_##name##_for(Args &&... args, <span class="keyword">const</span> std::chrono::duration<Rep, Period> &duration) noexcept \</div> +<div class="line"> { \</div> +<div class="line"> auto r = name(std::forward<Args>(args)..., duration); \</div> +<div class="line"> return !!r; \</div> +<div class="line"> } \</div> +<div class="line"> template <<span class="keyword">class</span>... Args, <span class="keyword">class </span>Clock, class Duration> \</div> +<div class="line"> bool try_##name##_until(Args &&... args, <span class="keyword">const</span> std::chrono::time_point<Clock, Duration> &timeout) noexcept \</div> +<div class="line"> { \</div> +<div class="line"> auto r = name(std::forward<Args>(args)..., timeout); \</div> +<div class="line"> return !!r; \</div> +<div class="line"> }</div> +</div><!-- fragment --> </div> </div> </div><!-- contents --> @@ -155,7 +327,7 @@ Macros</h2></td></tr> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9ffbcff25eb6a2bb8ed044f6c5d983c9.html">llfio</a></li><li class="navelem"><a class="el" href="dir_ff8d8ad368a820031e12dd9b12d79036.html">v2.0</a></li><li class="navelem"><a class="el" href="deadline_8h.html">deadline.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |