2022-07-31 19:38:16 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2024-12-15 01:45:58 +01:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2022-07-31 19:38:16 +02:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
2024-12-15 01:45:58 +01:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.9.8" / >
2022-07-31 19:38:16 +02:00
< 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 >
2024-12-15 01:45:58 +01:00
< tr id = "projectrow" >
< td id = "projectalign" >
2024-12-17 02:50:27 +01:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.0.1< / span >
2022-07-31 19:38:16 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2024-12-15 01:45:58 +01:00
<!-- Generated by Doxygen 1.9.8 -->
2022-07-31 19:38:16 +02:00
< script type = "text/javascript" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
2022-07-31 19:38:16 +02:00
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2022-07-31 19:38:16 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2024-12-15 01:45:58 +01:00
/* @license-end */
< / script >
2022-07-31 19:38:16 +02:00
< 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" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2022-07-31 19:38:16 +02:00
$(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" >
2024-12-15 01:45:58 +01:00
< 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 >
2022-07-31 19:38:16 +02:00
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "class_nim_b_l_e_ext_advertising-members.html" > List of all members< / a > < / div >
2024-12-15 01:45:58 +01:00
< div class = "headertitle" > < div class = "title" > NimBLEExtAdvertising Class Reference< / div > < / div >
2022-07-31 19:38:16 +02:00
< / div > <!-- header -->
< div class = "contents" >
< p > Extended advertising class.
< a href = "class_nim_b_l_e_ext_advertising.html#details" > More...< / a > < / p >
2024-12-15 01:45:58 +01:00
< p > < code > #include < < a class = "el" href = "_nim_b_l_e_ext_advertising_8h_source.html" > NimBLEExtAdvertising.h< / a > > < / code > < / p >
2022-07-31 19:38:16 +02:00
< table class = "memberdecls" >
2024-12-15 01:45:58 +01:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-methods" name = "pub-methods" > < / a >
2022-07-31 19:38:16 +02:00
Public Member Functions< / h2 > < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:afe321b856d785b78242b2ea020a96af3" id = "r_afe321b856d785b78242b2ea020a96af3" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "afe321b856d785b78242b2ea020a96af3" name = "afe321b856d785b78242b2ea020a96af3" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > NimBLEExtAdvertising< / b > ()< / td > < / tr >
< tr class = "memdesc:afe321b856d785b78242b2ea020a96af3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Constructor. < br / > < / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr class = "separator:afe321b856d785b78242b2ea020a96af3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a477c57db99ce3b5e987d6838b661808f" id = "r_a477c57db99ce3b5e987d6838b661808f" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a477c57db99ce3b5e987d6838b661808f" name = "a477c57db99ce3b5e987d6838b661808f" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > ~NimBLEExtAdvertising< / b > ()< / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr class = "memdesc:a477c57db99ce3b5e987d6838b661808f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Destructor: deletes callback instances if requested. < br / > < / td > < / tr >
< tr class = "separator:a477c57db99ce3b5e987d6838b661808f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a50ecfdca2fee14c6bcfffa110cc5e25a" id = "r_a50ecfdca2fee14c6bcfffa110cc5e25a" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_ext_advertising.html#a50ecfdca2fee14c6bcfffa110cc5e25a" > start< / a > (uint8_t instId, int duration=0, int maxEvents=0)< / td > < / tr >
< tr class = "memdesc:a50ecfdca2fee14c6bcfffa110cc5e25a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Start extended advertising. < br / > < / td > < / tr >
< tr class = "separator:a50ecfdca2fee14c6bcfffa110cc5e25a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:afbb3b7ea90d4a5b84bdc796c5844203e" id = "r_afbb3b7ea90d4a5b84bdc796c5844203e" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_ext_advertising.html#afbb3b7ea90d4a5b84bdc796c5844203e" > setInstanceData< / a > (uint8_t instId, < a class = "el" href = "class_nim_b_l_e_ext_advertisement.html" > NimBLEExtAdvertisement< / a > & adv)< / td > < / tr >
< tr class = "memdesc:afbb3b7ea90d4a5b84bdc796c5844203e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Register the extended advertisement data. < br / > < / td > < / tr >
< tr class = "separator:afbb3b7ea90d4a5b84bdc796c5844203e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac669489f8d7d67fe8dfc48ef15c7985f" id = "r_ac669489f8d7d67fe8dfc48ef15c7985f" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_ext_advertising.html#ac669489f8d7d67fe8dfc48ef15c7985f" > setScanResponseData< / a > (uint8_t instId, < a class = "el" href = "class_nim_b_l_e_ext_advertisement.html" > NimBLEExtAdvertisement< / a > & data)< / td > < / tr >
< tr class = "memdesc:ac669489f8d7d67fe8dfc48ef15c7985f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the scan response data for a legacy advertisement. < br / > < / td > < / tr >
< tr class = "separator:ac669489f8d7d67fe8dfc48ef15c7985f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:acace5e9e195b65b61041f7007f9359ab" id = "r_acace5e9e195b65b61041f7007f9359ab" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_ext_advertising.html#acace5e9e195b65b61041f7007f9359ab" > removeInstance< / a > (uint8_t instId)< / td > < / tr >
< tr class = "memdesc:acace5e9e195b65b61041f7007f9359ab" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Stop and remove this instance data from the advertisement set. < br / > < / td > < / tr >
< tr class = "separator:acace5e9e195b65b61041f7007f9359ab" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8c4df0be35301c90a39491b9e98d3e24" id = "r_a8c4df0be35301c90a39491b9e98d3e24" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / 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" >   < / td > < td class = "mdescRight" > Stop and remove all advertising instance data. < br / > < / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr class = "separator:a8c4df0be35301c90a39491b9e98d3e24" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a1dd95b432a8dfdfda20974a25da21953" id = "r_a1dd95b432a8dfdfda20974a25da21953" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_ext_advertising.html#a1dd95b432a8dfdfda20974a25da21953" > stop< / a > (uint8_t instId)< / td > < / tr >
< tr class = "memdesc:a1dd95b432a8dfdfda20974a25da21953" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Stop advertising this instance data. < br / > < / td > < / tr >
< tr class = "separator:a1dd95b432a8dfdfda20974a25da21953" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3ea2e93f8c3ce4498d30e4dac7b29109" id = "r_a3ea2e93f8c3ce4498d30e4dac7b29109" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / 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" >   < / td > < td class = "mdescRight" > Stop all advertisements. < br / > < / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr class = "separator:a3ea2e93f8c3ce4498d30e4dac7b29109" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a6fd8c8fff9fcb8be80c76774be031104" id = "r_a6fd8c8fff9fcb8be80c76774be031104" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_ext_advertising.html#a6fd8c8fff9fcb8be80c76774be031104" > isActive< / a > (uint8_t instId)< / td > < / tr >
< tr class = "memdesc:a6fd8c8fff9fcb8be80c76774be031104" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if currently advertising. < br / > < / td > < / tr >
< tr class = "separator:a6fd8c8fff9fcb8be80c76774be031104" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abd7d35653a6831e75700eb5ac9ab5789" id = "r_abd7d35653a6831e75700eb5ac9ab5789" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / 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" >   < / td > < td class = "mdescRight" > Check if any instances are currently advertising. < br / > < / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr class = "separator:abd7d35653a6831e75700eb5ac9ab5789" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:add623162d46c952d692e26888c9f8826" id = "r_add623162d46c952d692e26888c9f8826" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / 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" >   < / td > < td class = "mdescRight" > Set a callback to call when the advertisement stops. < br / > < / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr class = "separator:add623162d46c952d692e26888c9f8826" > < td class = "memSeparator" colspan = "2" >   < / 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 >
2024-12-15 01:45:58 +01:00
< a id = "a6fd8c8fff9fcb8be80c76774be031104" name = "a6fd8c8fff9fcb8be80c76774be031104" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6fd8c8fff9fcb8be80c76774be031104" > ◆   < / a > < / span > isActive()< / h2 >
2022-07-31 19:38:16 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEExtAdvertising::isActive < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > instId< / em > < / td > < td > )< / td >
2022-07-31 19:38:16 +02:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Check if currently advertising. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > instId< / td > < td > The instance ID of the advertised data to get the status of. < / td > < / tr >
2022-07-31 19:38:16 +02:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > True if advertising is active. < / dd > < / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "abd7d35653a6831e75700eb5ac9ab5789" name = "abd7d35653a6831e75700eb5ac9ab5789" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#abd7d35653a6831e75700eb5ac9ab5789" > ◆   < / a > < / span > isAdvertising()< / h2 >
2022-07-31 19:38:16 +02:00
< 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 >
2024-12-15 01:45:58 +01:00
< a id = "a8c4df0be35301c90a39491b9e98d3e24" name = "a8c4df0be35301c90a39491b9e98d3e24" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a8c4df0be35301c90a39491b9e98d3e24" > ◆   < / a > < / span > removeAll()< / h2 >
2022-07-31 19:38:16 +02:00
< 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 >
2024-12-15 01:45:58 +01:00
< a id = "acace5e9e195b65b61041f7007f9359ab" name = "acace5e9e195b65b61041f7007f9359ab" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#acace5e9e195b65b61041f7007f9359ab" > ◆   < / a > < / span > removeInstance()< / h2 >
2022-07-31 19:38:16 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEExtAdvertising::removeInstance < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > instId< / em > < / td > < td > )< / td >
2022-07-31 19:38:16 +02:00
< 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" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > instId< / td > < td > The extended advertisement instance to stop advertising. < / td > < / tr >
2022-07-31 19:38:16 +02:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > True if successful. < / dd > < / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "add623162d46c952d692e26888c9f8826" name = "add623162d46c952d692e26888c9f8826" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#add623162d46c952d692e26888c9f8826" > ◆   < / a > < / span > setCallbacks()< / h2 >
2022-07-31 19:38:16 +02:00
< 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 > *  < / td >
< td class = "paramname" > < em > pCallbacks< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > deleteCallbacks< / em > = < code > true< / code >   < / 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 >
2024-12-15 01:45:58 +01:00
< a id = "afbb3b7ea90d4a5b84bdc796c5844203e" name = "afbb3b7ea90d4a5b84bdc796c5844203e" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#afbb3b7ea90d4a5b84bdc796c5844203e" > ◆   < / a > < / span > setInstanceData()< / h2 >
2022-07-31 19:38:16 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEExtAdvertising::setInstanceData < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > instId< / em > , < / td >
2022-07-31 19:38:16 +02:00
< / 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 > &   < / td >
< td class = "paramname" > < em > adv< / em >   < / 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" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > instId< / td > < td > The extended advertisement instance ID to assign to this data. < / td > < / tr >
2022-07-31 19:38:16 +02:00
< 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 >
2024-12-15 01:45:58 +01:00
< a id = "ac669489f8d7d67fe8dfc48ef15c7985f" name = "ac669489f8d7d67fe8dfc48ef15c7985f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ac669489f8d7d67fe8dfc48ef15c7985f" > ◆   < / a > < / span > setScanResponseData()< / h2 >
2022-07-31 19:38:16 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEExtAdvertising::setScanResponseData < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > instId< / em > , < / td >
2022-07-31 19:38:16 +02:00
< / 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 > &   < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > data< / em >   < / td >
2022-07-31 19:38:16 +02:00
< / 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" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > instId< / td > < td > The extended advertisement instance ID to assign to this data. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > data< / 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 >
2022-07-31 19:38:16 +02:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "a50ecfdca2fee14c6bcfffa110cc5e25a" name = "a50ecfdca2fee14c6bcfffa110cc5e25a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a50ecfdca2fee14c6bcfffa110cc5e25a" > ◆   < / a > < / span > start()< / h2 >
2022-07-31 19:38:16 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEExtAdvertising::start < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > instId< / em > , < / td >
2022-07-31 19:38:16 +02:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > duration< / em > = < code > 0< / code > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > maxEvents< / em > = < code > 0< / code >   < / td >
2022-07-31 19:38:16 +02:00
< / 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" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > instId< / td > < td > The extended advertisement instance ID to start. < / td > < / tr >
2022-07-31 19:38:16 +02:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > duration< / td > < td > How long to advertise for in milliseconds, 0 = forever (default). < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > maxEvents< / td > < td > Maximum number of advertisement events to send, 0 = no limit (default). < / td > < / tr >
2022-07-31 19:38:16 +02:00
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > True if advertising started successfully. < / dd > < / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "a3ea2e93f8c3ce4498d30e4dac7b29109" name = "a3ea2e93f8c3ce4498d30e4dac7b29109" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a3ea2e93f8c3ce4498d30e4dac7b29109" > ◆   < / a > < / span > stop() < span class = "overload" > [1/2]< / span > < / h2 >
2022-07-31 19:38:16 +02:00
< 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 >
2024-12-15 01:45:58 +01:00
< a id = "a1dd95b432a8dfdfda20974a25da21953" name = "a1dd95b432a8dfdfda20974a25da21953" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1dd95b432a8dfdfda20974a25da21953" > ◆   < / a > < / span > stop() < span class = "overload" > [2/2]< / span > < / h2 >
2022-07-31 19:38:16 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEExtAdvertising::stop < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramname" > < em > instId< / em > < / td > < td > )< / td >
2022-07-31 19:38:16 +02:00
< 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" >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > instId< / td > < td > The extended advertisement instance to stop advertising. < / td > < / tr >
2022-07-31 19:38:16 +02:00
< / 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 >
2024-12-15 01:45:58 +01:00
< 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 >
2022-07-31 19:38:16 +02:00
< / ul >
< / div >
< / body >
< / html >
