2021-08-05 01:02:30 +00:00
<!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" />
2022-01-15 15:23:57 -07:00
< meta name = "generator" content = "Doxygen 1.9.1" />
2021-08-05 01:02:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
2022-01-15 15:23:57 -07:00
< title > esp-nimble-cpp: NimBLEAdvertisementData Class Reference</ title >
2021-08-05 01:02:30 +00:00
< 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;" >
2022-01-15 15:23:57 -07:00
< div id = "projectname" > esp-nimble-cpp
2022-07-31 11:38:16 -06:00
  < span id = "projectnumber" > 1.4.0</ span >
2021-08-05 01:02:30 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
2022-01-15 15:23:57 -07:00
<!-- Generated by Doxygen 1.9.1 -->
2021-08-05 01:02:30 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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&dn=gpl-2.0.txt GPL-v2 */
$ ( document ). ready ( function (){ initNavTree ( 'class_nim_b_l_e_advertisement_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" >
< 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 > |
< a href = "class_nim_b_l_e_advertisement_data-members.html" > List of all members</ a > </ div >
< div class = "headertitle" >
< div class = "title" > NimBLEAdvertisementData Class Reference</ div > </ div >
</ div > <!--header-->
< div class = "contents" >
< p > Advertisement data set by the programmer to be published by the BLE server.
< a href = "class_nim_b_l_e_advertisement_data.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:a0f209913ef9f3dfb5be8db39567b4f32" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32" > setAppearance</ a > (uint16_t appearance)</ td ></ tr >
< tr class = "memdesc:a0f209913ef9f3dfb5be8db39567b4f32" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the appearance. < a href = "class_nim_b_l_e_advertisement_data.html#a0f209913ef9f3dfb5be8db39567b4f32" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a0f209913ef9f3dfb5be8db39567b4f32" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a67fd95e586559b73964d5739051f3822" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822" > setCompleteServices</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid)</ td ></ tr >
< tr class = "memdesc:a67fd95e586559b73964d5739051f3822" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set a single service to advertise as a complete list of services. < a href = "class_nim_b_l_e_advertisement_data.html#a67fd95e586559b73964d5739051f3822" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a67fd95e586559b73964d5739051f3822" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a50a2584346208ef28274eeecc5befffb" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb" > setCompleteServices16</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & v_uuid)</ td ></ tr >
< tr class = "memdesc:a50a2584346208ef28274eeecc5befffb" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the complete list of 16 bit services to advertise. < a href = "class_nim_b_l_e_advertisement_data.html#a50a2584346208ef28274eeecc5befffb" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a50a2584346208ef28274eeecc5befffb" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a712aa09a4d7f2b3cae9b2f1f1be6372f" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f" > setCompleteServices32</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & v_uuid)</ td ></ tr >
< tr class = "memdesc:a712aa09a4d7f2b3cae9b2f1f1be6372f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the complete list of 32 bit services to advertise. < a href = "class_nim_b_l_e_advertisement_data.html#a712aa09a4d7f2b3cae9b2f1f1be6372f" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a712aa09a4d7f2b3cae9b2f1f1be6372f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a73766a872477512bd750c773d96ca4e2" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2" > setFlags</ a > (uint8_t)</ td ></ tr >
< tr class = "memdesc:a73766a872477512bd750c773d96ca4e2" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the advertisement flags. < a href = "class_nim_b_l_e_advertisement_data.html#a73766a872477512bd750c773d96ca4e2" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a73766a872477512bd750c773d96ca4e2" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa4df88b578782cda2bd77368b50f2d27" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27" > setManufacturerData</ a > (const std::string & data)</ td ></ tr >
< tr class = "memdesc:aa4df88b578782cda2bd77368b50f2d27" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set manufacturer specific data. < a href = "class_nim_b_l_e_advertisement_data.html#aa4df88b578782cda2bd77368b50f2d27" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:aa4df88b578782cda2bd77368b50f2d27" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa003bc4cf9bff2b2bcac9b742ec97a36" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36" > setURI</ a > (const std::string & uri)</ td ></ tr >
< tr class = "memdesc:aa003bc4cf9bff2b2bcac9b742ec97a36" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the URI to advertise. < a href = "class_nim_b_l_e_advertisement_data.html#aa003bc4cf9bff2b2bcac9b742ec97a36" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:aa003bc4cf9bff2b2bcac9b742ec97a36" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a885b4ed75dd71c4c19b86048c16350bf" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf" > setName</ a > (const std::string & name)</ td ></ tr >
< tr class = "memdesc:a885b4ed75dd71c4c19b86048c16350bf" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the complete name of this device. < a href = "class_nim_b_l_e_advertisement_data.html#a885b4ed75dd71c4c19b86048c16350bf" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a885b4ed75dd71c4c19b86048c16350bf" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:af52546d7c3b733a831f6232a845bef85" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85" > setPartialServices</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid)</ td ></ tr >
< tr class = "memdesc:af52546d7c3b733a831f6232a845bef85" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set a single service to advertise as a partial list of services. < a href = "class_nim_b_l_e_advertisement_data.html#af52546d7c3b733a831f6232a845bef85" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:af52546d7c3b733a831f6232a845bef85" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a50063c7ffa24f0f0407366a450e23ae4" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4" > setPartialServices16</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & v_uuid)</ td ></ tr >
< tr class = "memdesc:a50063c7ffa24f0f0407366a450e23ae4" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the partial list of services to advertise. < a href = "class_nim_b_l_e_advertisement_data.html#a50063c7ffa24f0f0407366a450e23ae4" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a50063c7ffa24f0f0407366a450e23ae4" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0ff5a72bccd349e551270ceadf528306" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306" > setPartialServices32</ a > (const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > & v_uuid)</ td ></ tr >
< tr class = "memdesc:a0ff5a72bccd349e551270ceadf528306" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the partial list of services to advertise. < a href = "class_nim_b_l_e_advertisement_data.html#a0ff5a72bccd349e551270ceadf528306" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a0ff5a72bccd349e551270ceadf528306" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aee4fdb5af06fcda9cab9fad3f5bf80d5" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5" > setServiceData</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, const std::string & data)</ td ></ tr >
< tr class = "memdesc:aee4fdb5af06fcda9cab9fad3f5bf80d5" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the service data (UUID + data) < a href = "class_nim_b_l_e_advertisement_data.html#aee4fdb5af06fcda9cab9fad3f5bf80d5" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:aee4fdb5af06fcda9cab9fad3f5bf80d5" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ae5b514ad9be6552727f1c7a744a29ae5" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5" > setShortName</ a > (const std::string & name)</ td ></ tr >
< tr class = "memdesc:ae5b514ad9be6552727f1c7a744a29ae5" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the short name. < a href = "class_nim_b_l_e_advertisement_data.html#ae5b514ad9be6552727f1c7a744a29ae5" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:ae5b514ad9be6552727f1c7a744a29ae5" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aec5f567059c4b4fd0f6b5fc74a0ce870" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870" > addData</ a > (const std::string & data)</ td ></ tr >
< tr class = "memdesc:aec5f567059c4b4fd0f6b5fc74a0ce870" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add data to the payload to be advertised. < a href = "class_nim_b_l_e_advertisement_data.html#aec5f567059c4b4fd0f6b5fc74a0ce870" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:aec5f567059c4b4fd0f6b5fc74a0ce870" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a2328f7df89a11d58818e98a6c889c8d4" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a2328f7df89a11d58818e98a6c889c8d4" > addData</ a > (char *data, size_t length)</ td ></ tr >
< tr class = "memdesc:a2328f7df89a11d58818e98a6c889c8d4" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add data to the payload to be advertised. < a href = "class_nim_b_l_e_advertisement_data.html#a2328f7df89a11d58818e98a6c889c8d4" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a2328f7df89a11d58818e98a6c889c8d4" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a480ffc91f212e877ae31ab47190006c3" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a480ffc91f212e877ae31ab47190006c3" ></ a >
void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a480ffc91f212e877ae31ab47190006c3" > addTxPower</ a > ()</ td ></ tr >
< tr class = "memdesc:a480ffc91f212e877ae31ab47190006c3" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Adds Tx power level to the advertisement data. < br /></ td ></ tr >
< tr class = "separator:a480ffc91f212e877ae31ab47190006c3" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a58ba06eb062a47cc58ba2829af8aafa5" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5" > setPreferredParams</ a > (uint16_t min, uint16_t max)</ td ></ tr >
< tr class = "memdesc:a58ba06eb062a47cc58ba2829af8aafa5" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the preferred connection interval parameters. < a href = "class_nim_b_l_e_advertisement_data.html#a58ba06eb062a47cc58ba2829af8aafa5" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:a58ba06eb062a47cc58ba2829af8aafa5" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:acbd638708c8b8b4663c09107bc38feb1" >< td class = "memItemLeft" align = "right" valign = "top" > std::string  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1" > getPayload</ a > ()</ td ></ tr >
< tr class = "memdesc:acbd638708c8b8b4663c09107bc38feb1" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Retrieve the payload that is to be advertised. < a href = "class_nim_b_l_e_advertisement_data.html#acbd638708c8b8b4663c09107bc38feb1" > More...</ a >< br /></ td ></ tr >
< tr class = "separator:acbd638708c8b8b4663c09107bc38feb1" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > Advertisement data set by the programmer to be published by the BLE server. </ p >
</ div >< h2 class = "groupheader" > Member Function Documentation</ h2 >
< a id = "a2328f7df89a11d58818e98a6c889c8d4" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a2328f7df89a11d58818e98a6c889c8d4" > ◆ </ a ></ span > addData() < span class = "overload" > [1/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::addData </ td >
< td > (</ td >
< td class = "paramtype" > char *  </ td >
< td class = "paramname" >< em > data</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > size_t  </ td >
< td class = "paramname" >< em > length</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Add data to the payload to be advertised. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to be added to the payload. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > length</ td >< td > The size of data to be added to the payload. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "aec5f567059c4b4fd0f6b5fc74a0ce870" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aec5f567059c4b4fd0f6b5fc74a0ce870" > ◆ </ a ></ span > addData() < span class = "overload" > [2/2]</ span ></ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::addData </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > data</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Add data to the payload to be advertised. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to be added to the payload. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "acbd638708c8b8b4663c09107bc38feb1" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#acbd638708c8b8b4663c09107bc38feb1" > ◆ </ a ></ span > getPayload()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string NimBLEAdvertisementData::getPayload </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Retrieve the payload that is to be advertised. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > The payload that is to be advertised. </ dd ></ dl >
</ div >
</ div >
< a id = "a0f209913ef9f3dfb5be8db39567b4f32" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0f209913ef9f3dfb5be8db39567b4f32" > ◆ </ a ></ span > setAppearance()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setAppearance </ td >
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > appearance</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the appearance. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > appearance</ td >< td > The appearance code value.</ td ></ tr >
</ table >
</ dd >
</ dl >
< p > See also: < a href = "https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml" > https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml</ a > </ p >
</ div >
</ div >
< a id = "a67fd95e586559b73964d5739051f3822" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a67fd95e586559b73964d5739051f3822" > ◆ </ a ></ span > setCompleteServices()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setCompleteServices </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set a single service to advertise as a complete list of services. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The service to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a50a2584346208ef28274eeecc5befffb" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a50a2584346208ef28274eeecc5befffb" > ◆ </ a ></ span > setCompleteServices16()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setCompleteServices16 </ td >
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
< td class = "paramname" >< em > v_uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the complete list of 16 bit services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > v_uuid</ td >< td > A vector of 16 bit UUID's to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a712aa09a4d7f2b3cae9b2f1f1be6372f" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a712aa09a4d7f2b3cae9b2f1f1be6372f" > ◆ </ a ></ span > setCompleteServices32()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setCompleteServices32 </ td >
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
< td class = "paramname" >< em > v_uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the complete list of 32 bit services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > v_uuid</ td >< td > A vector of 32 bit UUID's to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a73766a872477512bd750c773d96ca4e2" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a73766a872477512bd750c773d96ca4e2" > ◆ </ a ></ span > setFlags()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setFlags </ td >
< td > (</ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > flag</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the advertisement flags. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > flag</ td >< td > The flags to be set in the advertisement.< ul >
< li > BLE_HS_ADV_F_DISC_LTD</ li >
< li > BLE_HS_ADV_F_DISC_GEN</ li >
< li > BLE_HS_ADV_F_BREDR_UNSUP - must always use with NimBLE </ li >
</ ul >
</ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "aa4df88b578782cda2bd77368b50f2d27" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aa4df88b578782cda2bd77368b50f2d27" > ◆ </ a ></ span > setManufacturerData()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setManufacturerData </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > data</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set manufacturer specific data. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The manufacturer data to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a885b4ed75dd71c4c19b86048c16350bf" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a885b4ed75dd71c4c19b86048c16350bf" > ◆ </ a ></ span > setName()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setName </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > name</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the complete name of this device. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > name</ td >< td > The name to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "af52546d7c3b733a831f6232a845bef85" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#af52546d7c3b733a831f6232a845bef85" > ◆ </ a ></ span > setPartialServices()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setPartialServices </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set a single service to advertise as a partial list of services. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The service to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a50063c7ffa24f0f0407366a450e23ae4" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a50063c7ffa24f0f0407366a450e23ae4" > ◆ </ a ></ span > setPartialServices16()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setPartialServices16 </ td >
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
< td class = "paramname" >< em > v_uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the partial list of services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > v_uuid</ td >< td > A vector of 16 bit UUID's to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a0ff5a72bccd349e551270ceadf528306" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0ff5a72bccd349e551270ceadf528306" > ◆ </ a ></ span > setPartialServices32()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setPartialServices32 </ td >
< td > (</ td >
< td class = "paramtype" > const std::vector< < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > > &  </ td >
< td class = "paramname" >< em > v_uuid</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the partial list of services to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > v_uuid</ td >< td > A vector of 32 bit UUID's to advertise. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "a58ba06eb062a47cc58ba2829af8aafa5" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a58ba06eb062a47cc58ba2829af8aafa5" > ◆ </ a ></ span > setPreferredParams()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setPreferredParams </ td >
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > min</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > max</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the preferred connection interval parameters. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > min</ td >< td > The minimum interval desired. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > max</ td >< td > The maximum interval desired. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "aee4fdb5af06fcda9cab9fad3f5bf80d5" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aee4fdb5af06fcda9cab9fad3f5bf80d5" > ◆ </ a ></ span > setServiceData()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setServiceData </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
< td class = "paramname" >< em > uuid</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > data</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the service data (UUID + data) </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uuid</ td >< td > The UUID to set with the service data. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > data</ td >< td > The data to be associated with the service data advertised. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "ae5b514ad9be6552727f1c7a744a29ae5" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ae5b514ad9be6552727f1c7a744a29ae5" > ◆ </ a ></ span > setShortName()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setShortName </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > name</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the short name. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > name</ td >< td > The short name of the device. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "aa003bc4cf9bff2b2bcac9b742ec97a36" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aa003bc4cf9bff2b2bcac9b742ec97a36" > ◆ </ a ></ span > setURI()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEAdvertisementData::setURI </ td >
< td > (</ td >
< td class = "paramtype" > const std::string &  </ td >
< td class = "paramname" >< em > uri</ em ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Set the URI to advertise. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > uri</ td >< td > The uri to advertise. </ 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_advertisement_data.html" > NimBLEAdvertisementData</ a ></ li >
2022-01-15 15:23:57 -07: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.1 </ li >
2021-08-05 01:02:30 +00:00
</ ul >
</ div >
</ body >
</ html >
