mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 04:22:50 +02:00
517 lines
29 KiB
HTML
517 lines
29 KiB
HTML
<!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/services/async.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"> 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&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>
|
|
<!-- 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_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> </div>
|
|
<div class="headertitle"><div class="title">async.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>NS/NIM IAsync* IPC wrapper.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="types_8h_source.html">../types.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="service_8h_source.html">../sf/service.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="error_8h_source.html">../applets/error.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="event_8h_source.html">../kernel/event.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="async_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAsyncValue.html">AsyncValue</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structAsyncValue.html" title="AsyncValue.">AsyncValue</a>. <a href="structAsyncValue.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAsyncResult.html">AsyncResult</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structAsyncResult.html" title="AsyncResult.">AsyncResult</a>. <a href="structAsyncResult.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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><td colspan="2"><div class="groupHeader">IAsyncValue</div></td></tr>
|
|
<tr class="memitem:a3b04dbb7df9a19975bfb3f1b12c39700" id="r_a3b04dbb7df9a19975bfb3f1b12c39700"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a3b04dbb7df9a19975bfb3f1b12c39700">asyncValueClose</a> (<a class="el" href="structAsyncValue.html">AsyncValue</a> *a)</td></tr>
|
|
<tr class="memdesc:a3b04dbb7df9a19975bfb3f1b12c39700"><td class="mdescLeft"> </td><td class="mdescRight">Close a <a class="el" href="structAsyncValue.html">AsyncValue</a>. <br /></td></tr>
|
|
<tr class="separator:a3b04dbb7df9a19975bfb3f1b12c39700"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2b5cbeedfa443827b7c143d1d6167f2" id="r_ae2b5cbeedfa443827b7c143d1d6167f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#ae2b5cbeedfa443827b7c143d1d6167f2">asyncValueWait</a> (<a class="el" href="structAsyncValue.html">AsyncValue</a> *a, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout)</td></tr>
|
|
<tr class="memdesc:ae2b5cbeedfa443827b7c143d1d6167f2"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the async operation to finish using the specified timeout. <br /></td></tr>
|
|
<tr class="separator:ae2b5cbeedfa443827b7c143d1d6167f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41f156bd4eab4caa7f8f5a30d6695825" id="r_a41f156bd4eab4caa7f8f5a30d6695825"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a41f156bd4eab4caa7f8f5a30d6695825">asyncValueGetSize</a> (<a class="el" href="structAsyncValue.html">AsyncValue</a> *a, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *size)</td></tr>
|
|
<tr class="memdesc:a41f156bd4eab4caa7f8f5a30d6695825"><td class="mdescLeft"> </td><td class="mdescRight">Gets the value size. <br /></td></tr>
|
|
<tr class="separator:a41f156bd4eab4caa7f8f5a30d6695825"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bd698c56db3d2c6c9ba65433eac39b4" id="r_a4bd698c56db3d2c6c9ba65433eac39b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a4bd698c56db3d2c6c9ba65433eac39b4">asyncValueGet</a> (<a class="el" href="structAsyncValue.html">AsyncValue</a> *a, void *buffer, size_t size)</td></tr>
|
|
<tr class="memdesc:a4bd698c56db3d2c6c9ba65433eac39b4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the value. <br /></td></tr>
|
|
<tr class="separator:a4bd698c56db3d2c6c9ba65433eac39b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfcdd310d6f56d062732585bc20b4bbd" id="r_adfcdd310d6f56d062732585bc20b4bbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#adfcdd310d6f56d062732585bc20b4bbd">asyncValueCancel</a> (<a class="el" href="structAsyncValue.html">AsyncValue</a> *a)</td></tr>
|
|
<tr class="memdesc:adfcdd310d6f56d062732585bc20b4bbd"><td class="mdescLeft"> </td><td class="mdescRight">Cancels the async operation. <br /></td></tr>
|
|
<tr class="separator:adfcdd310d6f56d062732585bc20b4bbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8de48e4d47ede675f576122d99420c34" id="r_a8de48e4d47ede675f576122d99420c34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a8de48e4d47ede675f576122d99420c34">asyncValueGetErrorContext</a> (<a class="el" href="structAsyncValue.html">AsyncValue</a> *a, <a class="el" href="structErrorContext.html">ErrorContext</a> *context)</td></tr>
|
|
<tr class="memdesc:a8de48e4d47ede675f576122d99420c34"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="structErrorContext.html">ErrorContext</a>. <br /></td></tr>
|
|
<tr class="separator:a8de48e4d47ede675f576122d99420c34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">IAsyncResult</div></td></tr>
|
|
<tr class="memitem:ae2b08e3e428808854a4eed2f6fd8a4ec" id="r_ae2b08e3e428808854a4eed2f6fd8a4ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#ae2b08e3e428808854a4eed2f6fd8a4ec">asyncResultClose</a> (<a class="el" href="structAsyncResult.html">AsyncResult</a> *a)</td></tr>
|
|
<tr class="memdesc:ae2b08e3e428808854a4eed2f6fd8a4ec"><td class="mdescLeft"> </td><td class="mdescRight">Close a <a class="el" href="structAsyncResult.html">AsyncResult</a>. <br /></td></tr>
|
|
<tr class="separator:ae2b08e3e428808854a4eed2f6fd8a4ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea235d39f2bcb89015c6ce8a1a111e3f" id="r_aea235d39f2bcb89015c6ce8a1a111e3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#aea235d39f2bcb89015c6ce8a1a111e3f">asyncResultWait</a> (<a class="el" href="structAsyncResult.html">AsyncResult</a> *a, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout)</td></tr>
|
|
<tr class="memdesc:aea235d39f2bcb89015c6ce8a1a111e3f"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the async operation to finish using the specified timeout. <br /></td></tr>
|
|
<tr class="separator:aea235d39f2bcb89015c6ce8a1a111e3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47a8df1f777910f085c3536827523bba" id="r_a47a8df1f777910f085c3536827523bba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a47a8df1f777910f085c3536827523bba">asyncResultGet</a> (<a class="el" href="structAsyncResult.html">AsyncResult</a> *a)</td></tr>
|
|
<tr class="memdesc:a47a8df1f777910f085c3536827523bba"><td class="mdescLeft"> </td><td class="mdescRight">Gets the Result. <br /></td></tr>
|
|
<tr class="separator:a47a8df1f777910f085c3536827523bba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7584e48193c325eb03cce19a6ed6a382" id="r_a7584e48193c325eb03cce19a6ed6a382"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a7584e48193c325eb03cce19a6ed6a382">asyncResultCancel</a> (<a class="el" href="structAsyncResult.html">AsyncResult</a> *a)</td></tr>
|
|
<tr class="memdesc:a7584e48193c325eb03cce19a6ed6a382"><td class="mdescLeft"> </td><td class="mdescRight">Cancels the async operation. <br /></td></tr>
|
|
<tr class="separator:a7584e48193c325eb03cce19a6ed6a382"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e9dcdbbe9fd1380706074b555407da3" id="r_a4e9dcdbbe9fd1380706074b555407da3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="async_8h.html#a4e9dcdbbe9fd1380706074b555407da3">asyncResultGetErrorContext</a> (<a class="el" href="structAsyncResult.html">AsyncResult</a> *a, <a class="el" href="structErrorContext.html">ErrorContext</a> *context)</td></tr>
|
|
<tr class="memdesc:a4e9dcdbbe9fd1380706074b555407da3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="structErrorContext.html">ErrorContext</a>. <br /></td></tr>
|
|
<tr class="separator:a4e9dcdbbe9fd1380706074b555407da3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>NS/NIM IAsync* IPC wrapper. </p>
|
|
<dl class="section author"><dt>Author</dt><dd>yellows8 </dd></dl>
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a7584e48193c325eb03cce19a6ed6a382" name="a7584e48193c325eb03cce19a6ed6a382"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7584e48193c325eb03cce19a6ed6a382">◆ </a></span>asyncResultCancel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncResultCancel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncResult.html">AsyncResult</a> * </td>
|
|
<td class="paramname"><em>a</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Cancels the async operation. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Used automatically by <a class="el" href="async_8h.html#ae2b08e3e428808854a4eed2f6fd8a4ec">asyncResultClose</a>. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">a</td><td><a class="el" href="structAsyncResult.html">AsyncResult</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2b08e3e428808854a4eed2f6fd8a4ec" name="ae2b08e3e428808854a4eed2f6fd8a4ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2b08e3e428808854a4eed2f6fd8a4ec">◆ </a></span>asyncResultClose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void asyncResultClose </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncResult.html">AsyncResult</a> * </td>
|
|
<td class="paramname"><em>a</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Close a <a class="el" href="structAsyncResult.html">AsyncResult</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>When the object is initialized, this uses <a class="el" href="async_8h.html#a7584e48193c325eb03cce19a6ed6a382">asyncResultCancel</a> then <a class="el" href="async_8h.html#aea235d39f2bcb89015c6ce8a1a111e3f">asyncResultWait</a> with timeout=UINT64_MAX. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">a</td><td><a class="el" href="structAsyncResult.html">AsyncResult</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47a8df1f777910f085c3536827523bba" name="a47a8df1f777910f085c3536827523bba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47a8df1f777910f085c3536827523bba">◆ </a></span>asyncResultGet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncResultGet </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncResult.html">AsyncResult</a> * </td>
|
|
<td class="paramname"><em>a</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the Result. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Prior to using the cmd, this uses <a class="el" href="async_8h.html#aea235d39f2bcb89015c6ce8a1a111e3f">asyncResultWait</a> with timeout=UINT64_MAX. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">a</td><td><a class="el" href="structAsyncResult.html">AsyncResult</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e9dcdbbe9fd1380706074b555407da3" name="a4e9dcdbbe9fd1380706074b555407da3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e9dcdbbe9fd1380706074b555407da3">◆ </a></span>asyncResultGetErrorContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncResultGetErrorContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncResult.html">AsyncResult</a> * </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structErrorContext.html">ErrorContext</a> * </td>
|
|
<td class="paramname"><em>context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the <a class="el" href="structErrorContext.html">ErrorContext</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Only available on [4.0.0+]. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">a</td><td><a class="el" href="structAsyncResult.html">AsyncResult</a> </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">context</td><td><a class="el" href="structErrorContext.html">ErrorContext</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea235d39f2bcb89015c6ce8a1a111e3f" name="aea235d39f2bcb89015c6ce8a1a111e3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea235d39f2bcb89015c6ce8a1a111e3f">◆ </a></span>asyncResultWait()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncResultWait </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncResult.html">AsyncResult</a> * </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Waits for the async operation to finish using the specified timeout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">a</td><td><a class="el" href="structAsyncResult.html">AsyncResult</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Timeout in nanoseconds. UINT64_MAX for no timeout. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfcdd310d6f56d062732585bc20b4bbd" name="adfcdd310d6f56d062732585bc20b4bbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfcdd310d6f56d062732585bc20b4bbd">◆ </a></span>asyncValueCancel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncValueCancel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncValue.html">AsyncValue</a> * </td>
|
|
<td class="paramname"><em>a</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Cancels the async operation. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Used automatically by <a class="el" href="async_8h.html#a3b04dbb7df9a19975bfb3f1b12c39700">asyncValueClose</a>. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">a</td><td><a class="el" href="structAsyncValue.html">AsyncValue</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3b04dbb7df9a19975bfb3f1b12c39700" name="a3b04dbb7df9a19975bfb3f1b12c39700"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3b04dbb7df9a19975bfb3f1b12c39700">◆ </a></span>asyncValueClose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void asyncValueClose </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncValue.html">AsyncValue</a> * </td>
|
|
<td class="paramname"><em>a</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Close a <a class="el" href="structAsyncValue.html">AsyncValue</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>When the object is initialized, this uses <a class="el" href="async_8h.html#adfcdd310d6f56d062732585bc20b4bbd">asyncValueCancel</a> then <a class="el" href="async_8h.html#ae2b5cbeedfa443827b7c143d1d6167f2">asyncValueWait</a> with timeout=UINT64_MAX. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">a</td><td><a class="el" href="structAsyncValue.html">AsyncValue</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bd698c56db3d2c6c9ba65433eac39b4" name="a4bd698c56db3d2c6c9ba65433eac39b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bd698c56db3d2c6c9ba65433eac39b4">◆ </a></span>asyncValueGet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncValueGet </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncValue.html">AsyncValue</a> * </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the value. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Prior to using the cmd, this uses <a class="el" href="async_8h.html#aea235d39f2bcb89015c6ce8a1a111e3f">asyncResultWait</a> with timeout=UINT64_MAX. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">a</td><td><a class="el" href="structAsyncValue.html">AsyncValue</a> </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Output buffer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Output buffer size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8de48e4d47ede675f576122d99420c34" name="a8de48e4d47ede675f576122d99420c34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8de48e4d47ede675f576122d99420c34">◆ </a></span>asyncValueGetErrorContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncValueGetErrorContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncValue.html">AsyncValue</a> * </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structErrorContext.html">ErrorContext</a> * </td>
|
|
<td class="paramname"><em>context</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the <a class="el" href="structErrorContext.html">ErrorContext</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Only available on [4.0.0+]. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">a</td><td><a class="el" href="structAsyncValue.html">AsyncValue</a> </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">context</td><td><a class="el" href="structErrorContext.html">ErrorContext</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a41f156bd4eab4caa7f8f5a30d6695825" name="a41f156bd4eab4caa7f8f5a30d6695825"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41f156bd4eab4caa7f8f5a30d6695825">◆ </a></span>asyncValueGetSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncValueGetSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncValue.html">AsyncValue</a> * </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> * </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the value size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">a</td><td><a class="el" href="structAsyncValue.html">AsyncValue</a> </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Output size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2b5cbeedfa443827b7c143d1d6167f2" name="ae2b5cbeedfa443827b7c143d1d6167f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2b5cbeedfa443827b7c143d1d6167f2">◆ </a></span>asyncValueWait()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> asyncValueWait </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structAsyncValue.html">AsyncValue</a> * </td>
|
|
<td class="paramname"><em>a</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>timeout</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Waits for the async operation to finish using the specified timeout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">a</td><td><a class="el" href="structAsyncValue.html">AsyncValue</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>Timeout in nanoseconds. UINT64_MAX for no timeout. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|