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/class_nim_b_l_e_scan_callbacks.html
h2zero c47dd827c7 deploy: a6ed1933bc
2024-12-15 00:45:58 +00:00

242 lines
11 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: NimBLEScanCallbacks Class 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.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>
</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('class_nim_b_l_e_scan_callbacks.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="class_nim_b_l_e_scan_callbacks-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">NimBLEScanCallbacks Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A callback handler for callbacks associated device scanning.
<a href="class_nim_b_l_e_scan_callbacks.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nim_b_l_e_scan_8h_source.html">NimBLEScan.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:a1f9b5eac5982340afbb84954a4c06277" id="r_a1f9b5eac5982340afbb84954a4c06277"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_callbacks.html#a1f9b5eac5982340afbb84954a4c06277">onDiscovered</a> (const <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *advertisedDevice)</td></tr>
<tr class="memdesc:a1f9b5eac5982340afbb84954a4c06277"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a new device is discovered, before the scan result is received (if applicable). <br /></td></tr>
<tr class="separator:a1f9b5eac5982340afbb84954a4c06277"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962d8b08cf14ac3091e6fd6962d7e283" id="r_a962d8b08cf14ac3091e6fd6962d7e283"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_callbacks.html#a962d8b08cf14ac3091e6fd6962d7e283">onResult</a> (const <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *advertisedDevice)</td></tr>
<tr class="memdesc:a962d8b08cf14ac3091e6fd6962d7e283"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a new scan result is complete, including scan response data (if applicable). <br /></td></tr>
<tr class="separator:a962d8b08cf14ac3091e6fd6962d7e283"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61c11db405e87ec847066ca3b6ad8375" id="r_a61c11db405e87ec847066ca3b6ad8375"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_callbacks.html#a61c11db405e87ec847066ca3b6ad8375">onScanEnd</a> (const <a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> &amp;scanResults, int reason)</td></tr>
<tr class="memdesc:a61c11db405e87ec847066ca3b6ad8375"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a scan operation ends. <br /></td></tr>
<tr class="separator:a61c11db405e87ec847066ca3b6ad8375"><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 callback handler for callbacks associated device scanning. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1f9b5eac5982340afbb84954a4c06277" name="a1f9b5eac5982340afbb84954a4c06277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f9b5eac5982340afbb84954a4c06277">&#9670;&#160;</a></span>onDiscovered()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEScanCallbacks::onDiscovered </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *&#160;</td>
<td class="paramname"><em>advertisedDevice</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a new device is discovered, before the scan result is received (if applicable). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advertisedDevice</td><td>The device which was discovered. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a962d8b08cf14ac3091e6fd6962d7e283" name="a962d8b08cf14ac3091e6fd6962d7e283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962d8b08cf14ac3091e6fd6962d7e283">&#9670;&#160;</a></span>onResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEScanCallbacks::onResult </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *&#160;</td>
<td class="paramname"><em>advertisedDevice</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a new scan result is complete, including scan response data (if applicable). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">advertisedDevice</td><td>The device for which the complete result is available. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a61c11db405e87ec847066ca3b6ad8375" name="a61c11db405e87ec847066ca3b6ad8375"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61c11db405e87ec847066ca3b6ad8375">&#9670;&#160;</a></span>onScanEnd()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEScanCallbacks::onScanEnd </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a> &amp;&#160;</td>
<td class="paramname"><em>scanResults</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>reason</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a scan operation ends. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">scanResults</td><td>The results of the scan that ended. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reason</td><td>The reason code for why the scan ended. </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="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</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