171 lines
15 KiB
HTML
171 lines
15 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: l4/re/util/poll_timeout_kipclock 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('poll__timeout__kipclock_source.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle"><div class="title">poll_timeout_kipclock</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// vi:set ft=cpp: -*- Mode: C++ -*-</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * (c) 2012 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * economic rights: Technische Universität Dresden (Germany)</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * License: see LICENSE.spdx (in this directory or the directories above)</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="code" href="sys_2kip_8h.html">l4/sys/kip.h</a>></span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <<a class="code" href="env_8h.html">l4/re/env.h</a>></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceL4.html">L4</a> {</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span></div>
|
|
<div class="foldopen" id="foldopen00035" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classL4_1_1Poll__timeout__kipclock.html"> 35</a></span><span class="keyword">class </span><a class="code hl_function" href="classL4_1_1Poll__timeout__kipclock.html#a0b0d86579969353be5308ef67c875576">Poll_timeout_kipclock</a></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>{</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">public</span>:</div>
|
|
<div class="foldopen" id="foldopen00042" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classL4_1_1Poll__timeout__kipclock.html#a0b0d86579969353be5308ef67c875576"> 42</a></span> <a class="code hl_function" href="classL4_1_1Poll__timeout__kipclock.html#a0b0d86579969353be5308ef67c875576">Poll_timeout_kipclock</a>(<span class="keywordtype">unsigned</span> poll_time_us)</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_function" href="classL4_1_1Poll__timeout__kipclock.html#a5a981174ea6408e39c3a80b8cdb92831">set</a>(poll_time_us);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span></div>
|
|
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classL4_1_1Poll__timeout__kipclock.html#a5a981174ea6408e39c3a80b8cdb92831"> 51</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classL4_1_1Poll__timeout__kipclock.html#a5a981174ea6408e39c3a80b8cdb92831">set</a>(<span class="keywordtype">unsigned</span> poll_time_us)</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> {</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> _timeout = <a class="code hl_function" href="group__l4__kip__api.html#gadeb6bfd4fa27bf58c9bd60302dbbb044">l4_kip_clock</a>(<a class="code hl_function" href="group__api__l4re__env.html#gaa3380feabe4b5440ed7e246fdf15f333">l4re_kip</a>()) + poll_time_us;</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> _last_check = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span></div>
|
|
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classL4_1_1Poll__timeout__kipclock.html#a5901a2c8eefa9640939fd91cb57e4bf2"> 65</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classL4_1_1Poll__timeout__kipclock.html#a5901a2c8eefa9640939fd91cb57e4bf2">test</a>(<span class="keywordtype">bool</span> expression = <span class="keyword">true</span>)</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordflow">if</span> (!expression)</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> _last_check = <a class="code hl_function" href="group__l4__kip__api.html#gadeb6bfd4fa27bf58c9bd60302dbbb044">l4_kip_clock</a>(<a class="code hl_function" href="group__api__l4re__env.html#gaa3380feabe4b5440ed7e246fdf15f333">l4re_kip</a>()) < _timeout;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classL4_1_1Poll__timeout__kipclock.html#a6783096f90ee37e1b3dfda705c4cd0bb"> 77</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classL4_1_1Poll__timeout__kipclock.html#a6783096f90ee37e1b3dfda705c4cd0bb">timed_out</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !_last_check; }</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_typedef" href="group__l4__basic__types.html#ga6efe5a2c466cba633dbb23611b8eb458">l4_cpu_time_t</a> _timeout;</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">bool</span> _last_check;</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>}</div>
|
|
<div class="ttc" id="aclassL4_1_1Poll__timeout__kipclock_html_a0b0d86579969353be5308ef67c875576"><div class="ttname"><a href="classL4_1_1Poll__timeout__kipclock.html#a0b0d86579969353be5308ef67c875576">L4::Poll_timeout_kipclock::Poll_timeout_kipclock</a></div><div class="ttdeci">Poll_timeout_kipclock(unsigned poll_time_us)</div><div class="ttdoc">Initialise relative timeout in microseconds.</div><div class="ttdef"><b>Definition</b> <a href="#l00042">poll_timeout_kipclock:42</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Poll__timeout__kipclock_html_a5901a2c8eefa9640939fd91cb57e4bf2"><div class="ttname"><a href="classL4_1_1Poll__timeout__kipclock.html#a5901a2c8eefa9640939fd91cb57e4bf2">L4::Poll_timeout_kipclock::test</a></div><div class="ttdeci">bool test(bool expression=true)</div><div class="ttdoc">Test whether timeout has expired.</div><div class="ttdef"><b>Definition</b> <a href="#l00065">poll_timeout_kipclock:65</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Poll__timeout__kipclock_html_a5a981174ea6408e39c3a80b8cdb92831"><div class="ttname"><a href="classL4_1_1Poll__timeout__kipclock.html#a5a981174ea6408e39c3a80b8cdb92831">L4::Poll_timeout_kipclock::set</a></div><div class="ttdeci">void set(unsigned poll_time_us)</div><div class="ttdoc">(Re-)Set relative timeout in microseconds</div><div class="ttdef"><b>Definition</b> <a href="#l00051">poll_timeout_kipclock:51</a></div></div>
|
|
<div class="ttc" id="aclassL4_1_1Poll__timeout__kipclock_html_a6783096f90ee37e1b3dfda705c4cd0bb"><div class="ttname"><a href="classL4_1_1Poll__timeout__kipclock.html#a6783096f90ee37e1b3dfda705c4cd0bb">L4::Poll_timeout_kipclock::timed_out</a></div><div class="ttdeci">bool timed_out() const</div><div class="ttdoc">Query whether timeout has expired.</div><div class="ttdef"><b>Definition</b> <a href="#l00077">poll_timeout_kipclock:77</a></div></div>
|
|
<div class="ttc" id="aenv_8h_html"><div class="ttname"><a href="env_8h.html">env.h</a></div><div class="ttdoc">Environment interface.</div></div>
|
|
<div class="ttc" id="agroup__api__l4re__env_html_gaa3380feabe4b5440ed7e246fdf15f333"><div class="ttname"><a href="group__api__l4re__env.html#gaa3380feabe4b5440ed7e246fdf15f333">l4re_kip</a></div><div class="ttdeci">l4_kernel_info_t const * l4re_kip(void) L4_NOTHROW</div><div class="ttdoc">Get Kernel Info Page.</div><div class="ttdef"><b>Definition</b> <a href="env_8h_source.html#l00185">env.h:185</a></div></div>
|
|
<div class="ttc" id="agroup__l4__basic__types_html_ga6efe5a2c466cba633dbb23611b8eb458"><div class="ttname"><a href="group__l4__basic__types.html#ga6efe5a2c466cba633dbb23611b8eb458">l4_cpu_time_t</a></div><div class="ttdeci">l4_uint64_t l4_cpu_time_t</div><div class="ttdoc">CPU clock type.</div><div class="ttdef"><b>Definition</b> <a href="l4_2sys_2l4int_8h_source.html#l00047">l4int.h:47</a></div></div>
|
|
<div class="ttc" id="agroup__l4__kip__api_html_gadeb6bfd4fa27bf58c9bd60302dbbb044"><div class="ttname"><a href="group__l4__kip__api.html#gadeb6bfd4fa27bf58c9bd60302dbbb044">l4_kip_clock</a></div><div class="ttdeci">l4_cpu_time_t l4_kip_clock(l4_kernel_info_t const *kip) L4_NOTHROW</div><div class="ttdoc">Return clock value from the KIP.</div><div class="ttdef"><b>Definition</b> <a href="sys_2kip_8h_source.html#l00242">kip.h:242</a></div></div>
|
|
<div class="ttc" id="anamespaceL4_html"><div class="ttname"><a href="namespaceL4.html">L4</a></div><div class="ttdoc">L4 low-level kernel interface.</div><div class="ttdef"><b>Definition</b> <a href="l4sys-l4f-groups_8dox_source.html#l00050">l4sys-l4f-groups.dox:50</a></div></div>
|
|
<div class="ttc" id="asys_2kip_8h_html"><div class="ttname"><a href="sys_2kip_8h.html">kip.h</a></div><div class="ttdoc">Kernel Info Page access functions.</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><b>util</b></li><li class="navelem"><b>poll_timeout_kipclock</b></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|