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.html
h2zero a116f0d0c0 Release v1.4.0
2022-07-31 11:38:16 -06:00

448 lines
23 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: NimBLEExtAdvertising 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.0</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.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-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEExtAdvertising Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Extended advertising class.
<a href="class_nim_b_l_e_ext_advertising.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:afe321b856d785b78242b2ea020a96af3"><td class="memItemLeft" align="right" valign="top"><a id="afe321b856d785b78242b2ea020a96af3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#afe321b856d785b78242b2ea020a96af3">NimBLEExtAdvertising</a> ()</td></tr>
<tr class="memdesc:afe321b856d785b78242b2ea020a96af3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an extended advertising object. <br /></td></tr>
<tr class="separator:afe321b856d785b78242b2ea020a96af3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a477c57db99ce3b5e987d6838b661808f"><td class="memItemLeft" align="right" valign="top"><a id="a477c57db99ce3b5e987d6838b661808f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a477c57db99ce3b5e987d6838b661808f">~NimBLEExtAdvertising</a> ()</td></tr>
<tr class="memdesc:a477c57db99ce3b5e987d6838b661808f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor: deletes callback instances if requested. <br /></td></tr>
<tr class="separator:a477c57db99ce3b5e987d6838b661808f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8044a281a37f4d7c96166ce6f0851159"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a8044a281a37f4d7c96166ce6f0851159">start</a> (uint8_t inst_id, int duration=0, int max_events=0)</td></tr>
<tr class="memdesc:a8044a281a37f4d7c96166ce6f0851159"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start extended advertising. <a href="class_nim_b_l_e_ext_advertising.html#a8044a281a37f4d7c96166ce6f0851159">More...</a><br /></td></tr>
<tr class="separator:a8044a281a37f4d7c96166ce6f0851159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a321fb75a0ffacedfb54da4cc00484b7c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a321fb75a0ffacedfb54da4cc00484b7c">setInstanceData</a> (uint8_t inst_id, <a class="el" href="class_nim_b_l_e_ext_advertisement.html">NimBLEExtAdvertisement</a> &amp;adv)</td></tr>
<tr class="memdesc:a321fb75a0ffacedfb54da4cc00484b7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register the extended advertisement data. <a href="class_nim_b_l_e_ext_advertising.html#a321fb75a0ffacedfb54da4cc00484b7c">More...</a><br /></td></tr>
<tr class="separator:a321fb75a0ffacedfb54da4cc00484b7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9395a0087e96329591ed2515cc21456b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a9395a0087e96329591ed2515cc21456b">setScanResponseData</a> (uint8_t inst_id, <a class="el" href="class_nim_b_l_e_ext_advertisement.html">NimBLEExtAdvertisement</a> &amp;data)</td></tr>
<tr class="memdesc:a9395a0087e96329591ed2515cc21456b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the scan response data for a legacy advertisement. <a href="class_nim_b_l_e_ext_advertising.html#a9395a0087e96329591ed2515cc21456b">More...</a><br /></td></tr>
<tr class="separator:a9395a0087e96329591ed2515cc21456b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7f4225f33f03d17efba1d4de0684eef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#af7f4225f33f03d17efba1d4de0684eef">removeInstance</a> (uint8_t inst_id)</td></tr>
<tr class="memdesc:af7f4225f33f03d17efba1d4de0684eef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop and remove this instance data from the advertisement set. <a href="class_nim_b_l_e_ext_advertising.html#af7f4225f33f03d17efba1d4de0684eef">More...</a><br /></td></tr>
<tr class="separator:af7f4225f33f03d17efba1d4de0684eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c4df0be35301c90a39491b9e98d3e24"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a8c4df0be35301c90a39491b9e98d3e24">removeAll</a> ()</td></tr>
<tr class="memdesc:a8c4df0be35301c90a39491b9e98d3e24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop and remove all advertising instance data. <a href="class_nim_b_l_e_ext_advertising.html#a8c4df0be35301c90a39491b9e98d3e24">More...</a><br /></td></tr>
<tr class="separator:a8c4df0be35301c90a39491b9e98d3e24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02b4e33908456341fb98753d51316609"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a02b4e33908456341fb98753d51316609">stop</a> (uint8_t inst_id)</td></tr>
<tr class="memdesc:a02b4e33908456341fb98753d51316609"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop advertising this instance data. <a href="class_nim_b_l_e_ext_advertising.html#a02b4e33908456341fb98753d51316609">More...</a><br /></td></tr>
<tr class="separator:a02b4e33908456341fb98753d51316609"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ea2e93f8c3ce4498d30e4dac7b29109"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a3ea2e93f8c3ce4498d30e4dac7b29109">stop</a> ()</td></tr>
<tr class="memdesc:a3ea2e93f8c3ce4498d30e4dac7b29109"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop all advertisements. <a href="class_nim_b_l_e_ext_advertising.html#a3ea2e93f8c3ce4498d30e4dac7b29109">More...</a><br /></td></tr>
<tr class="separator:a3ea2e93f8c3ce4498d30e4dac7b29109"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ebe0b664cf22449e1a4311fc3b9b01"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#a88ebe0b664cf22449e1a4311fc3b9b01">isActive</a> (uint8_t inst_id)</td></tr>
<tr class="memdesc:a88ebe0b664cf22449e1a4311fc3b9b01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if currently advertising. <a href="class_nim_b_l_e_ext_advertising.html#a88ebe0b664cf22449e1a4311fc3b9b01">More...</a><br /></td></tr>
<tr class="separator:a88ebe0b664cf22449e1a4311fc3b9b01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd7d35653a6831e75700eb5ac9ab5789"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#abd7d35653a6831e75700eb5ac9ab5789">isAdvertising</a> ()</td></tr>
<tr class="memdesc:abd7d35653a6831e75700eb5ac9ab5789"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if any instances are currently advertising. <a href="class_nim_b_l_e_ext_advertising.html#abd7d35653a6831e75700eb5ac9ab5789">More...</a><br /></td></tr>
<tr class="separator:abd7d35653a6831e75700eb5ac9ab5789"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add623162d46c952d692e26888c9f8826"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_ext_advertising.html#add623162d46c952d692e26888c9f8826">setCallbacks</a> (<a class="el" href="class_nim_b_l_e_ext_advertising_callbacks.html">NimBLEExtAdvertisingCallbacks</a> *callbacks, bool deleteCallbacks=true)</td></tr>
<tr class="memdesc:add623162d46c952d692e26888c9f8826"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a callback to call when the advertisement stops. <a href="class_nim_b_l_e_ext_advertising.html#add623162d46c952d692e26888c9f8826">More...</a><br /></td></tr>
<tr class="separator:add623162d46c952d692e26888c9f8826"><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>Extended advertising class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a88ebe0b664cf22449e1a4311fc3b9b01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ebe0b664cf22449e1a4311fc3b9b01">&#9670;&nbsp;</a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::isActive </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if currently advertising. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The instance ID of the advertised data to get the status of. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising is active. </dd></dl>
</div>
</div>
<a id="abd7d35653a6831e75700eb5ac9ab5789"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd7d35653a6831e75700eb5ac9ab5789">&#9670;&nbsp;</a></span>isAdvertising()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::isAdvertising </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if any instances are currently advertising. </p>
<dl class="section return"><dt>Returns</dt><dd>True if any instance is active. </dd></dl>
</div>
</div>
<a id="a8c4df0be35301c90a39491b9e98d3e24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c4df0be35301c90a39491b9e98d3e24">&#9670;&nbsp;</a></span>removeAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::removeAll </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop and remove all advertising instance data. </p>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
</div>
</div>
<a id="af7f4225f33f03d17efba1d4de0684eef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7f4225f33f03d17efba1d4de0684eef">&#9670;&nbsp;</a></span>removeInstance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::removeInstance </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop and remove this instance data from the advertisement set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance to stop advertising. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
</div>
</div>
<a id="add623162d46c952d692e26888c9f8826"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add623162d46c952d692e26888c9f8826">&#9670;&nbsp;</a></span>setCallbacks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEExtAdvertising::setCallbacks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_ext_advertising_callbacks.html">NimBLEExtAdvertisingCallbacks</a> *&#160;</td>
<td class="paramname"><em>pCallbacks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>deleteCallbacks</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a callback to call when the advertisement stops. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pCallbacks</td><td>A pointer to a callback to be invoked when an advertisement stops. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">deleteCallbacks</td><td>if true callback class will be deleted when advertising is destructed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a321fb75a0ffacedfb54da4cc00484b7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a321fb75a0ffacedfb54da4cc00484b7c">&#9670;&nbsp;</a></span>setInstanceData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::setInstanceData </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_ext_advertisement.html">NimBLEExtAdvertisement</a> &amp;&#160;</td>
<td class="paramname"><em>adv</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register the extended advertisement data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to assign to this data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">adv</td><td>The extended advertisement instance with the data to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising started successfully. </dd></dl>
</div>
</div>
<a id="a9395a0087e96329591ed2515cc21456b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9395a0087e96329591ed2515cc21456b">&#9670;&nbsp;</a></span>setScanResponseData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::setScanResponseData </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_ext_advertisement.html">NimBLEExtAdvertisement</a> &amp;&#160;</td>
<td class="paramname"><em>lsr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the scan response data for a legacy advertisement. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to assign to this data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lsr</td><td>A reference to a <a class="el" href="class_nim_b_l_e_ext_advertisement.html" title="Extended advertisement data.">NimBLEExtAdvertisement</a> that contains the data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8044a281a37f4d7c96166ce6f0851159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8044a281a37f4d7c96166ce6f0851159">&#9670;&nbsp;</a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::start </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">int&#160;</td>
<td class="paramname"><em>duration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_events</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start extended advertising. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to start. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>How long to advertise for in milliseconds, 0 = forever (default). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_events</td><td>Maximum number of advertisement events to send, 0 = no limit (default). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising started successfully. </dd></dl>
</div>
</div>
<a id="a3ea2e93f8c3ce4498d30e4dac7b29109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ea2e93f8c3ce4498d30e4dac7b29109">&#9670;&nbsp;</a></span>stop() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop all advertisements. </p>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>
</div>
</div>
<a id="a02b4e33908456341fb98753d51316609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02b4e33908456341fb98753d51316609">&#9670;&nbsp;</a></span>stop() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEExtAdvertising::stop </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop advertising this instance data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance to stop advertising. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </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_ext_advertising.html">NimBLEExtAdvertising</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