ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-26 04:30:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/struct_nim_b_l_e_task_data.html
h2zero 059364985d deploy: 275def333c
2024-12-17 01:50:27 +00:00

172 lines
8.2 KiB
HTML
Raw 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>esp-nimble-cpp: NimBLETaskData Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">esp-nimble-cpp<span id="projectnumber">&#160;2.0.1</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>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('struct_nim_b_l_e_task_data.html',''); initResizable(); });
/* @license-end */
</script>
<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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="struct_nim_b_l_e_task_data-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">NimBLETaskData Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A structure to hold data for a task that is waiting for a response.
<a href="struct_nim_b_l_e_task_data.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nim_b_l_e_utils_8h_source.html">NimBLEUtils.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7b08f7ba2161d6309da1fc40c83027c4" id="r_a7b08f7ba2161d6309da1fc40c83027c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_nim_b_l_e_task_data.html#a7b08f7ba2161d6309da1fc40c83027c4">NimBLETaskData</a> (void *pInstance=nullptr, int flags=0, void *buf=nullptr)</td></tr>
<tr class="memdesc:a7b08f7ba2161d6309da1fc40c83027c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="struct_nim_b_l_e_task_data.html" title="A structure to hold data for a task that is waiting for a response.">NimBLETaskData</a> instance. <br /></td></tr>
<tr class="separator:a7b08f7ba2161d6309da1fc40c83027c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2d5d10d7cc8801cf4d001f89bf301c6" id="r_af2d5d10d7cc8801cf4d001f89bf301c6"><td class="memItemLeft" align="right" valign="top"><a id="af2d5d10d7cc8801cf4d001f89bf301c6" name="af2d5d10d7cc8801cf4d001f89bf301c6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~NimBLETaskData</b> ()</td></tr>
<tr class="memdesc:af2d5d10d7cc8801cf4d001f89bf301c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:af2d5d10d7cc8801cf4d001f89bf301c6"><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>A structure to hold data for a task that is waiting for a response. </p>
<p>This structure is used in conjunction with <a class="el" href="class_nim_b_l_e_utils.html#a6b3a170f26ce51f353ff960f59739181" title="Blocks the calling task until released or timeout.">NimBLEUtils::taskWait()</a> and <a class="el" href="class_nim_b_l_e_utils.html#a7b2de1e3827f9f6750550623dc6d9288" title="Release a task.">NimBLEUtils::taskRelease()</a>. All items are optional, the m_pHandle will be set in taskWait(). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7b08f7ba2161d6309da1fc40c83027c4" name="a7b08f7ba2161d6309da1fc40c83027c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b08f7ba2161d6309da1fc40c83027c4">&#9670;&#160;</a></span>NimBLETaskData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NimBLETaskData::NimBLETaskData </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>pInstance</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="struct_nim_b_l_e_task_data.html" title="A structure to hold data for a task that is waiting for a response.">NimBLETaskData</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pInstance</td><td>An instance of the class that will be waiting. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>General purpose flags for the caller. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>A buffer for data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a></li>
<li class="footer">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 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink