mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-13 06:32:13 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/utimer_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

261 lines
14 KiB
HTML
Raw Permalink Blame History

<!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>libnx: include/switch/kernel/utimer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_36b4ff30955378a33ed199d75bfba1a9.html">kernel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">utimer.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>User-mode timer synchronization primitive.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="wait_8h_source.html">wait.h</a>&quot;</code><br />
</div>
<p><a href="utimer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structUTimer.html">UTimer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-mode timer object. <a href="structUTimer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ad3a7c38fbde9814e427a75171fe8939d" id="r_ad3a7c38fbde9814e427a75171fe8939d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939d">TimerType</a> { <br />
&#160;&#160;<a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939daa93702ca4175addaf9d0e4568751f670">TimerType_OneShot</a>
, <br />
&#160;&#160;<a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939dafa3d743de0084bf94270e7f81e2e4281">TimerType_Repeating</a>
<br />
}</td></tr>
<tr class="memdesc:ad3a7c38fbde9814e427a75171fe8939d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Valid types for a user-mode timer. <a href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939d">More...</a><br /></td></tr>
<tr class="separator:ad3a7c38fbde9814e427a75171fe8939d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7e69adeeb3bcff5119c6d749a5bc4765" id="r_a7e69adeeb3bcff5119c6d749a5bc4765"><td class="memItemLeft" align="right" valign="top"><a id="a7e69adeeb3bcff5119c6d749a5bc4765" name="a7e69adeeb3bcff5119c6d749a5bc4765"></a>
static <a class="el" href="structWaiter.html">Waiter</a>&#160;</td><td class="memItemRight" valign="bottom"><b>waiterForUTimer</b> (<a class="el" href="structUTimer.html">UTimer</a> *t)</td></tr>
<tr class="memdesc:a7e69adeeb3bcff5119c6d749a5bc4765"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a waiter for a user-mode timer. <br /></td></tr>
<tr class="separator:a7e69adeeb3bcff5119c6d749a5bc4765"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe2fd11c8a8306e5d2e102d9820e1b9" id="r_a6fe2fd11c8a8306e5d2e102d9820e1b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utimer_8h.html#a6fe2fd11c8a8306e5d2e102d9820e1b9">utimerCreate</a> (<a class="el" href="structUTimer.html">UTimer</a> *t, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> interval, <a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939d">TimerType</a> type)</td></tr>
<tr class="memdesc:a6fe2fd11c8a8306e5d2e102d9820e1b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a user-mode timer. <br /></td></tr>
<tr class="separator:a6fe2fd11c8a8306e5d2e102d9820e1b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44c6f3457b84802dfc9151d325fc1113" id="r_a44c6f3457b84802dfc9151d325fc1113"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utimer_8h.html#a44c6f3457b84802dfc9151d325fc1113">utimerStart</a> (<a class="el" href="structUTimer.html">UTimer</a> *t)</td></tr>
<tr class="memdesc:a44c6f3457b84802dfc9151d325fc1113"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the timer. <br /></td></tr>
<tr class="separator:a44c6f3457b84802dfc9151d325fc1113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abefdd14da8eb8f912407d2e4220aba82" id="r_abefdd14da8eb8f912407d2e4220aba82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="utimer_8h.html#abefdd14da8eb8f912407d2e4220aba82">utimerStop</a> (<a class="el" href="structUTimer.html">UTimer</a> *t)</td></tr>
<tr class="memdesc:abefdd14da8eb8f912407d2e4220aba82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the timer. <br /></td></tr>
<tr class="separator:abefdd14da8eb8f912407d2e4220aba82"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>User-mode timer synchronization primitive. </p>
<dl class="section author"><dt>Author</dt><dd>plutoo </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ad3a7c38fbde9814e427a75171fe8939d" name="ad3a7c38fbde9814e427a75171fe8939d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3a7c38fbde9814e427a75171fe8939d">&#9670;&#160;</a></span>TimerType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939d">TimerType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Valid types for a user-mode timer. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ad3a7c38fbde9814e427a75171fe8939daa93702ca4175addaf9d0e4568751f670" name="ad3a7c38fbde9814e427a75171fe8939daa93702ca4175addaf9d0e4568751f670"></a>TimerType_OneShot&#160;</td><td class="fielddoc"><p>Timers of this kind fire once and then stop automatically. </p>
</td></tr>
<tr><td class="fieldname"><a id="ad3a7c38fbde9814e427a75171fe8939dafa3d743de0084bf94270e7f81e2e4281" name="ad3a7c38fbde9814e427a75171fe8939dafa3d743de0084bf94270e7f81e2e4281"></a>TimerType_Repeating&#160;</td><td class="fielddoc"><p>Timers of this kind fire periodically. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6fe2fd11c8a8306e5d2e102d9820e1b9" name="a6fe2fd11c8a8306e5d2e102d9820e1b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fe2fd11c8a8306e5d2e102d9820e1b9">&#9670;&#160;</a></span>utimerCreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utimerCreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUTimer.html">UTimer</a> *&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>interval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939d">TimerType</a>&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a user-mode timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">t</td><td><a class="el" href="structUTimer.html" title="User-mode timer object.">UTimer</a> object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">interval</td><td>Interval (in nanoseconds). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of timer to create (see <a class="el" href="utimer_8h.html#ad3a7c38fbde9814e427a75171fe8939d">TimerType</a>). </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The timer is stopped when it is created. Use <a class="el" href="utimer_8h.html#a44c6f3457b84802dfc9151d325fc1113">utimerStart</a> to start it. </dd>
<dd>
It is safe to wait on this timer with several threads simultaneously. </dd>
<dd>
If more than one thread is listening on it, at least one thread will get the signal. No other guarantees. </dd>
<dd>
For a repeating timer: If the timer triggers twice before you wait on it, you will only get one signal. </dd></dl>
</div>
</div>
<a id="a44c6f3457b84802dfc9151d325fc1113" name="a44c6f3457b84802dfc9151d325fc1113"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44c6f3457b84802dfc9151d325fc1113">&#9670;&#160;</a></span>utimerStart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utimerStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUTimer.html">UTimer</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">t</td><td><a class="el" href="structUTimer.html" title="User-mode timer object.">UTimer</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abefdd14da8eb8f912407d2e4220aba82" name="abefdd14da8eb8f912407d2e4220aba82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abefdd14da8eb8f912407d2e4220aba82">&#9670;&#160;</a></span>utimerStop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void utimerStop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUTimer.html">UTimer</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">t</td><td><a class="el" href="structUTimer.html" title="User-mode timer object.">UTimer</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink