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_ext_advertising_callbacks.html
h2zero 73d39b0a88 deploy: afdeff7871
2022-10-30 17:19:11 +00:00

223 lines
10 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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp: NimBLEExtAdvertisingCallbacks 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_ext_advertising_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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_ext_advertising_callbacks-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEExtAdvertisingCallbacks Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Callbacks associated with <a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a> class.
<a href="class_nim_b_l_e_ext_advertising_callbacks.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a07004fd4e849aa8e9bd7106cbf6ab94b"><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_ext_advertising_callbacks.html#a07004fd4e849aa8e9bd7106cbf6ab94b">onStopped</a> (<a class="el" href="class_nim_b_l_e_ext_advertising.html">NimBLEExtAdvertising</a> *pAdv, int reason, uint8_t inst_id)</td></tr>
<tr class="memdesc:a07004fd4e849aa8e9bd7106cbf6ab94b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle an advertising stop event. <a href="class_nim_b_l_e_ext_advertising_callbacks.html#a07004fd4e849aa8e9bd7106cbf6ab94b">More...</a><br /></td></tr>
<tr class="separator:a07004fd4e849aa8e9bd7106cbf6ab94b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92af7bd791095cf91438b7af4c26263f"><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_ext_advertising_callbacks.html#a92af7bd791095cf91438b7af4c26263f">onScanRequest</a> (<a class="el" href="class_nim_b_l_e_ext_advertising.html">NimBLEExtAdvertising</a> *pAdv, uint8_t inst_id, <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> addr)</td></tr>
<tr class="memdesc:a92af7bd791095cf91438b7af4c26263f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle a scan response request. This is called when a scanning device requests a scan response. <a href="class_nim_b_l_e_ext_advertising_callbacks.html#a92af7bd791095cf91438b7af4c26263f">More...</a><br /></td></tr>
<tr class="separator:a92af7bd791095cf91438b7af4c26263f"><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>Callbacks associated with <a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a> class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a92af7bd791095cf91438b7af4c26263f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92af7bd791095cf91438b7af4c26263f">&#9670;&nbsp;</a></span>onScanRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEExtAdvertisingCallbacks::onScanRequest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_ext_advertising.html">NimBLEExtAdvertising</a> *&#160;</td>
<td class="paramname"><em>pAdv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a>&#160;</td>
<td class="paramname"><em>addr</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>Handle a scan response request. This is called when a scanning device requests a scan response. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pAdv</td><td>A convenience pointer to the extended advertising interface. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The instance ID of the advertisement that the scan response request was made. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>The address of the device making the request. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a07004fd4e849aa8e9bd7106cbf6ab94b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07004fd4e849aa8e9bd7106cbf6ab94b">&#9670;&nbsp;</a></span>onStopped()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEExtAdvertisingCallbacks::onStopped </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_ext_advertising.html">NimBLEExtAdvertising</a> *&#160;</td>
<td class="paramname"><em>pAdv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>reason</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</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>Handle an advertising stop event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pAdv</td><td>A convenience pointer to the extended advertising interface. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reason</td><td>The reason code for stopping the advertising. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The instance ID of the advertisement that was stopped.</td></tr>
</table>
</dd>
</dl>
<p>Default callback handlers </p>
</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_ext_advertising_callbacks.html">NimBLEExtAdvertisingCallbacks</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.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink