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">
2024-12-15 00:45:58 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-08-05 01:02:30 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" />
2024-12-15 00:45:58 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" />
< meta name = "generator" content = "Doxygen 1.9.8" />
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: NimBLEService 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 >
2024-12-15 00:45:58 +00:00
< tr id = "projectrow" >
< td id = "projectalign" >
2025-01-13 02:22:00 +00:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.1.0</ span >
2021-08-05 01:02:30 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
2024-12-15 00:45:58 +00:00
<!-- Generated by Doxygen 1.9.8 -->
2021-08-05 01:02:30 +00:00
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox ( "searchBox" , "search/" , '.html' );
2021-08-05 01:02:30 +00: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 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( function () {
initMenu ( '' , true , false , 'search.php' , 'Search' );
$ ( document ). ready ( function () { init_search (); });
});
2024-12-15 00:45:58 +00:00
/* @license-end */
</ script >
2021-08-05 01:02:30 +00: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 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( document ). ready ( function (){ initNavTree ( 'class_nim_b_l_e_service.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 00:45:58 +00: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 >
2021-08-05 01:02:30 +00:00
</ div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "class_nim_b_l_e_service-members.html" > List of all members</ a > </ div >
2024-12-15 00:45:58 +00:00
< div class = "headertitle" >< div class = "title" > NimBLEService Class Reference</ div ></ div >
2021-08-05 01:02:30 +00:00
</ div > <!--header-->
< div class = "contents" >
< p > The model of a BLE service.
< a href = "class_nim_b_l_e_service.html#details" > More...</ a ></ p >
2024-12-15 00:45:58 +00:00
< p >< code > #include < < a class = "el" href = "_nim_b_l_e_service_8h_source.html" > NimBLEService.h</ a > > </ code ></ p >
< p > Inherits < a class = "el" href = "class_nim_b_l_e_local_attribute.html" > NimBLELocalAttribute</ a > .</ p >
2021-08-05 01:02:30 +00:00
< table class = "memberdecls" >
2024-12-15 00:45:58 +00:00
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-methods" name = "pub-methods" ></ a >
2021-08-05 01:02:30 +00:00
Public Member Functions</ h2 ></ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a5084a6db9c9b5ddb4f3e9261606b1e65" id = "r_a5084a6db9c9b5ddb4f3e9261606b1e65" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a5084a6db9c9b5ddb4f3e9261606b1e65" > NimBLEService</ a > (const char *uuid)</ td ></ tr >
< tr class = "memdesc:a5084a6db9c9b5ddb4f3e9261606b1e65" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct an instance of the < a class = "el" href = "class_nim_b_l_e_service.html" title = "The model of a BLE service." > NimBLEService</ a > . < br /></ td ></ tr >
2022-01-15 15:23:57 -07:00
< tr class = "separator:a5084a6db9c9b5ddb4f3e9261606b1e65" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:af4e9e030046352a6ff3d9ba67fe872e3" id = "r_af4e9e030046352a6ff3d9ba67fe872e3" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#af4e9e030046352a6ff3d9ba67fe872e3" > NimBLEService</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid)</ td ></ tr >
< tr class = "memdesc:af4e9e030046352a6ff3d9ba67fe872e3" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct an instance of the BLEService. < br /></ td ></ tr >
2022-01-15 15:23:57 -07:00
< tr class = "separator:af4e9e030046352a6ff3d9ba67fe872e3" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a8904838e785b967c770a240e6c5099e7" id = "r_a8904838e785b967c770a240e6c5099e7" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a8904838e785b967c770a240e6c5099e7" name = "a8904838e785b967c770a240e6c5099e7" ></ a >
  </ td >< td class = "memItemRight" valign = "bottom" >< b > ~NimBLEService</ b > ()</ td ></ tr >
< tr class = "memdesc:a8904838e785b967c770a240e6c5099e7" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Destructor, make sure we release the resources allocated for the service. < br /></ td ></ tr >
< tr class = "separator:a8904838e785b967c770a240e6c5099e7" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:acfbb7abadee89abd496b89f8fe085f58" id = "r_acfbb7abadee89abd496b89f8fe085f58" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#acfbb7abadee89abd496b89f8fe085f58" > getServer</ a > () const</ td ></ tr >
< tr class = "memdesc:acfbb7abadee89abd496b89f8fe085f58" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the BLE server associated with this service. < br /></ td ></ tr >
< tr class = "separator:acfbb7abadee89abd496b89f8fe085f58" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a819ff207ef7c30f59887af277aa09ce9" id = "r_a819ff207ef7c30f59887af277aa09ce9" >< td class = "memItemLeft" align = "right" valign = "top" > std::string  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a819ff207ef7c30f59887af277aa09ce9" > toString</ a > () const</ td ></ tr >
< tr class = "memdesc:a819ff207ef7c30f59887af277aa09ce9" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Return a string representation of this service. A service is defined by: < br /></ td ></ tr >
< tr class = "separator:a819ff207ef7c30f59887af277aa09ce9" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a8fafb0c55e447114daf9ad758218905e" id = "r_a8fafb0c55e447114daf9ad758218905e" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a8fafb0c55e447114daf9ad758218905e" name = "a8fafb0c55e447114daf9ad758218905e" ></ a >
void  </ td >< td class = "memItemRight" valign = "bottom" >< b > dump</ b > () const</ td ></ tr >
< tr class = "memdesc:a8fafb0c55e447114daf9ad758218905e" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Dump details of this BLE GATT service. < br /></ td ></ tr >
< tr class = "separator:a8fafb0c55e447114daf9ad758218905e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa9464e97d7e39a4634c5d9bdce1abbac" id = "r_aa9464e97d7e39a4634c5d9bdce1abbac" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#aa9464e97d7e39a4634c5d9bdce1abbac" > isStarted</ a > () const</ td ></ tr >
< tr class = "memdesc:aa9464e97d7e39a4634c5d9bdce1abbac" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Checks if the service has been started. < br /></ td ></ tr >
< tr class = "separator:aa9464e97d7e39a4634c5d9bdce1abbac" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ad37324ed0404d596923d6fdc0133b985" id = "r_ad37324ed0404d596923d6fdc0133b985" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#ad37324ed0404d596923d6fdc0133b985" > start</ a > ()</ td ></ tr >
< tr class = "memdesc:ad37324ed0404d596923d6fdc0133b985" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Builds the database of characteristics/descriptors for the service and registers it with the NimBLE stack. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:ad37324ed0404d596923d6fdc0133b985" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a415e1b836946831c6f9edd74adba8763" id = "r_a415e1b836946831c6f9edd74adba8763" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a415e1b836946831c6f9edd74adba8763" > createCharacteristic</ a > (const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</ td ></ tr >
< tr class = "memdesc:a415e1b836946831c6f9edd74adba8763" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Create a new BLE Characteristic associated with this service. < br /></ td ></ tr >
2022-07-31 11:38:16 -06:00
< tr class = "separator:a415e1b836946831c6f9edd74adba8763" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:aa780d072e6257258e27cbc96106626ad" id = "r_aa780d072e6257258e27cbc96106626ad" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#aa780d072e6257258e27cbc96106626ad" > createCharacteristic</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</ td ></ tr >
< tr class = "memdesc:aa780d072e6257258e27cbc96106626ad" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Create a new BLE Characteristic associated with this service. < br /></ td ></ tr >
2022-07-31 11:38:16 -06:00
< tr class = "separator:aa780d072e6257258e27cbc96106626ad" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:af8215dbfdaf7ced32d6158f8ff5116e8" id = "r_af8215dbfdaf7ced32d6158f8ff5116e8" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#af8215dbfdaf7ced32d6158f8ff5116e8" > addCharacteristic</ a > (< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *pCharacteristic)</ td ></ tr >
< tr class = "memdesc:af8215dbfdaf7ced32d6158f8ff5116e8" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Add a characteristic to the service. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:af8215dbfdaf7ced32d6158f8ff5116e8" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:af992d0c27e3a559789fb77fc46623234" id = "r_af992d0c27e3a559789fb77fc46623234" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#af992d0c27e3a559789fb77fc46623234" > removeCharacteristic</ a > (< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *pCharacteristic, bool deleteChr=false)</ td ></ tr >
< tr class = "memdesc:af992d0c27e3a559789fb77fc46623234" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Remove a characteristic from the service. < br /></ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr class = "separator:af992d0c27e3a559789fb77fc46623234" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:aeeaa4b0c543230e7819ad92d48432f5e" id = "r_aeeaa4b0c543230e7819ad92d48432f5e" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#aeeaa4b0c543230e7819ad92d48432f5e" > getCharacteristic</ a > (const char *uuid, uint16_t instanceId=0) const</ td ></ tr >
< tr class = "memdesc:aeeaa4b0c543230e7819ad92d48432f5e" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get a pointer to the characteristic object with the specified UUID. < br /></ td ></ tr >
< tr class = "separator:aeeaa4b0c543230e7819ad92d48432f5e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a200714f911accd64acfd2fa3d0c6b863" id = "r_a200714f911accd64acfd2fa3d0c6b863" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a200714f911accd64acfd2fa3d0c6b863" > getCharacteristic</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, uint16_t instanceId=0) const</ td ></ tr >
< tr class = "memdesc:a200714f911accd64acfd2fa3d0c6b863" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get a pointer to the characteristic object with the specified UUID. < br /></ td ></ tr >
< tr class = "separator:a200714f911accd64acfd2fa3d0c6b863" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a488df9c39d1c49d4b1537abddddb1a7d" id = "r_a488df9c39d1c49d4b1537abddddb1a7d" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a488df9c39d1c49d4b1537abddddb1a7d" > getCharacteristicByHandle</ a > (uint16_t handle) const</ td ></ tr >
< tr class = "memdesc:a488df9c39d1c49d4b1537abddddb1a7d" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get a pointer to the characteristic object with the specified handle. < br /></ td ></ tr >
< tr class = "separator:a488df9c39d1c49d4b1537abddddb1a7d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a8219ccefd97180bee485b62572c62e58" id = "r_a8219ccefd97180bee485b62572c62e58" >< td class = "memItemLeft" align = "right" valign = "top" > const std::vector< < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * > &  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a8219ccefd97180bee485b62572c62e58" > getCharacteristics</ a > () const</ td ></ tr >
< tr class = "separator:a8219ccefd97180bee485b62572c62e58" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a9bb082780665005271fab6e79416f3ed" id = "r_a9bb082780665005271fab6e79416f3ed" >< td class = "memItemLeft" align = "right" valign = "top" > std::vector< < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * >  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a9bb082780665005271fab6e79416f3ed" > getCharacteristics</ a > (const char *uuid) const</ td ></ tr >
< tr class = "separator:a9bb082780665005271fab6e79416f3ed" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a557ec314a4b2f912b1c1b03e332f9fe1" id = "r_a557ec314a4b2f912b1c1b03e332f9fe1" >< td class = "memItemLeft" align = "right" valign = "top" > std::vector< < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * >  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_service.html#a557ec314a4b2f912b1c1b03e332f9fe1" > getCharacteristics</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid) const</ td ></ tr >
< tr class = "separator:a557ec314a4b2f912b1c1b03e332f9fe1" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_methods_class_nim_b_l_e_local_attribute" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_class_nim_b_l_e_local_attribute')" >< img src = "closed.png" alt = "-" />   Public Member Functions inherited from < a class = "el" href = "class_nim_b_l_e_local_attribute.html" > NimBLELocalAttribute</ a ></ td ></ tr >
< tr class = "memitem:a7664b8e5353f33ebfcff20a63273fe55 inherit pub_methods_class_nim_b_l_e_local_attribute" id = "r_a7664b8e5353f33ebfcff20a63273fe55" >< td class = "memItemLeft" align = "right" valign = "top" > uint8_t  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_local_attribute.html#a7664b8e5353f33ebfcff20a63273fe55" > getRemoved</ a > () const</ td ></ tr >
< tr class = "memdesc:a7664b8e5353f33ebfcff20a63273fe55 inherit pub_methods_class_nim_b_l_e_local_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the removed flag. < br /></ td ></ tr >
< tr class = "separator:a7664b8e5353f33ebfcff20a63273fe55 inherit pub_methods_class_nim_b_l_e_local_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pub_methods_class_nim_b_l_e_attribute" >< td colspan = "2" onclick = "javascript:toggleInherit('pub_methods_class_nim_b_l_e_attribute')" >< img src = "closed.png" alt = "-" />   Public Member Functions inherited from < a class = "el" href = "class_nim_b_l_e_attribute.html" > NimBLEAttribute</ a ></ td ></ tr >
< tr class = "memitem:afd4500e543c9480c52ca994ed5473e49 inherit pub_methods_class_nim_b_l_e_attribute" id = "r_afd4500e543c9480c52ca994ed5473e49" >< td class = "memItemLeft" align = "right" valign = "top" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_attribute.html#afd4500e543c9480c52ca994ed5473e49" > getUUID</ a > () const</ td ></ tr >
< tr class = "memdesc:afd4500e543c9480c52ca994ed5473e49 inherit pub_methods_class_nim_b_l_e_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the UUID of the attribute. < br /></ td ></ tr >
< tr class = "separator:afd4500e543c9480c52ca994ed5473e49 inherit pub_methods_class_nim_b_l_e_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a7907cb5b0a2d0f8cd9eb016a4ed876d1 inherit pub_methods_class_nim_b_l_e_attribute" id = "r_a7907cb5b0a2d0f8cd9eb016a4ed876d1" >< td class = "memItemLeft" align = "right" valign = "top" >
uint16_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getHandle</ b > () const</ td ></ tr >
< tr class = "memdesc:a7907cb5b0a2d0f8cd9eb016a4ed876d1 inherit pub_methods_class_nim_b_l_e_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the handle of the attribute. < br /></ td ></ tr >
< tr class = "separator:a7907cb5b0a2d0f8cd9eb016a4ed876d1 inherit pub_methods_class_nim_b_l_e_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "inherited" name = "inherited" ></ a >
Additional Inherited Members</ h2 ></ td ></ tr >
< tr class = "inherit_header pro_methods_class_nim_b_l_e_local_attribute" >< td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_class_nim_b_l_e_local_attribute')" >< img src = "closed.png" alt = "-" />   Protected Member Functions inherited from < a class = "el" href = "class_nim_b_l_e_local_attribute.html" > NimBLELocalAttribute</ a ></ td ></ tr >
< tr class = "memitem:a9fd2c2130f8bea42f86ee0d3263e9788 inherit pro_methods_class_nim_b_l_e_local_attribute" id = "r_a9fd2c2130f8bea42f86ee0d3263e9788" >< td class = "memItemLeft" align = "right" valign = "top" >
  </ td >< td class = "memItemRight" valign = "bottom" >< b > NimBLELocalAttribute</ b > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, uint16_t handle)</ td ></ tr >
< tr class = "memdesc:a9fd2c2130f8bea42f86ee0d3263e9788 inherit pro_methods_class_nim_b_l_e_local_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct a local attribute. < br /></ td ></ tr >
< tr class = "separator:a9fd2c2130f8bea42f86ee0d3263e9788 inherit pro_methods_class_nim_b_l_e_local_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:af3a224e382c76e2bc2040d033e4f165b inherit pro_methods_class_nim_b_l_e_local_attribute" id = "r_af3a224e382c76e2bc2040d033e4f165b" >< td class = "memItemLeft" align = "right" valign = "top" >
  </ td >< td class = "memItemRight" valign = "bottom" >< b > ~NimBLELocalAttribute</ b > ()=default</ td ></ tr >
< tr class = "memdesc:af3a224e382c76e2bc2040d033e4f165b inherit pro_methods_class_nim_b_l_e_local_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Destroy the local attribute. < br /></ td ></ tr >
< tr class = "separator:af3a224e382c76e2bc2040d033e4f165b inherit pro_methods_class_nim_b_l_e_local_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a4d8b3828536a49051311bc236157a8a4 inherit pro_methods_class_nim_b_l_e_local_attribute" id = "r_a4d8b3828536a49051311bc236157a8a4" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_local_attribute.html#a4d8b3828536a49051311bc236157a8a4" > setRemoved</ a > (uint8_t removed)</ td ></ tr >
< tr class = "memdesc:a4d8b3828536a49051311bc236157a8a4 inherit pro_methods_class_nim_b_l_e_local_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Set the removed flag. < br /></ td ></ tr >
< tr class = "separator:a4d8b3828536a49051311bc236157a8a4 inherit pro_methods_class_nim_b_l_e_local_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "inherit_header pro_methods_class_nim_b_l_e_attribute" >< td colspan = "2" onclick = "javascript:toggleInherit('pro_methods_class_nim_b_l_e_attribute')" >< img src = "closed.png" alt = "-" />   Protected Member Functions inherited from < a class = "el" href = "class_nim_b_l_e_attribute.html" > NimBLEAttribute</ a ></ td ></ tr >
< tr class = "memitem:a51ce8e9cd9609f42b9b9248a0b6c642c inherit pro_methods_class_nim_b_l_e_attribute" id = "r_a51ce8e9cd9609f42b9b9248a0b6c642c" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_attribute.html#a51ce8e9cd9609f42b9b9248a0b6c642c" > NimBLEAttribute</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid, uint16_t handle)</ td ></ tr >
< tr class = "memdesc:a51ce8e9cd9609f42b9b9248a0b6c642c inherit pro_methods_class_nim_b_l_e_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct a new < a class = "el" href = "class_nim_b_l_e_attribute.html" title = "A base class for BLE attributes." > NimBLEAttribute</ a > object. < br /></ td ></ tr >
< tr class = "separator:a51ce8e9cd9609f42b9b9248a0b6c642c inherit pro_methods_class_nim_b_l_e_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a8a060f480742cfb09ed47c1f5421d00f inherit pro_methods_class_nim_b_l_e_attribute" id = "r_a8a060f480742cfb09ed47c1f5421d00f" >< td class = "memItemLeft" align = "right" valign = "top" >
  </ td >< td class = "memItemRight" valign = "bottom" >< b > ~NimBLEAttribute</ b > ()=default</ td ></ tr >
< tr class = "memdesc:a8a060f480742cfb09ed47c1f5421d00f inherit pro_methods_class_nim_b_l_e_attribute" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Destroy the < a class = "el" href = "class_nim_b_l_e_attribute.html" title = "A base class for BLE attributes." > NimBLEAttribute</ a > object. < br /></ td ></ tr >
< tr class = "separator:a8a060f480742cfb09ed47c1f5421d00f inherit pro_methods_class_nim_b_l_e_attribute" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > The model of a BLE service. </ p >
</ div >< h2 class = "groupheader" > Constructor & Destructor Documentation</ h2 >
2024-12-15 00:45:58 +00:00
< a id = "a5084a6db9c9b5ddb4f3e9261606b1e65" name = "a5084a6db9c9b5ddb4f3e9261606b1e65" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a5084a6db9c9b5ddb4f3e9261606b1e65" > ◆  </ a ></ span > NimBLEService() < span class = "overload" > [1/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > NimBLEService::NimBLEService </ td >
< td > (</ td >
< td class = "paramtype" > const char *  </ td >
2022-01-15 15:23:57 -07:00
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Construct an instance of the < a class = "el" href = "class_nim_b_l_e_service.html" title = "The model of a BLE service." > NimBLEService</ a > . </ 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 of the service. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "af4e9e030046352a6ff3d9ba67fe872e3" name = "af4e9e030046352a6ff3d9ba67fe872e3" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#af4e9e030046352a6ff3d9ba67fe872e3" > ◆  </ a ></ span > NimBLEService() < span class = "overload" > [2/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > NimBLEService::NimBLEService </ td >
< td > (</ td >
< td class = "paramtype" > const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > &  </ td >
2022-01-15 15:23:57 -07:00
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Construct an instance of the BLEService. </ 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 of the service. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< h2 class = "groupheader" > Member Function Documentation</ h2 >
2024-12-15 00:45:58 +00:00
< a id = "af8215dbfdaf7ced32d6158f8ff5116e8" name = "af8215dbfdaf7ced32d6158f8ff5116e8" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#af8215dbfdaf7ced32d6158f8ff5116e8" > ◆  </ a ></ span > addCharacteristic()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEService::addCharacteristic </ td >
< td > (</ td >
< td class = "paramtype" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > pChar</ em ></ td >< td > )</ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Add a characteristic to the service. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > pChar</ td >< td > A pointer to the characteristic instance to add to the service. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a415e1b836946831c6f9edd74adba8763" name = "a415e1b836946831c6f9edd74adba8763" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a415e1b836946831c6f9edd74adba8763" > ◆  </ a ></ span > createCharacteristic() < span class = "overload" > [1/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * NimBLEService::createCharacteristic </ td >
< td > (</ td >
< td class = "paramtype" > const char *  </ td >
< td class = "paramname" >< em > uuid</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint32_t  </ td >
2022-07-31 11:38:16 -06:00
< td class = "paramname" >< em > properties</ em > = < code > NIMBLE_PROPERTY::READ  |  NIMBLE_PROPERTY::WRITE</ code > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > max_len</ em > = < code > BLE_ATT_ATTR_MAX_LEN</ code >   </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Create a new BLE Characteristic associated with this service. </ 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 of the characteristic. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > properties</ td >< td > - The properties of the characteristic. </ td ></ tr >
2022-07-31 11:38:16 -06:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > max_len</ td >< td > - The maximum length in bytes that the characteristic value can hold. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > The new BLE characteristic. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aa780d072e6257258e27cbc96106626ad" name = "aa780d072e6257258e27cbc96106626ad" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aa780d072e6257258e27cbc96106626ad" > ◆  </ a ></ span > createCharacteristic() < span class = "overload" > [2/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * NimBLEService::createCharacteristic </ 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" > uint32_t  </ td >
2022-07-31 11:38:16 -06:00
< td class = "paramname" >< em > properties</ em > = < code > NIMBLE_PROPERTY::READ  |  NIMBLE_PROPERTY::WRITE</ code > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > max_len</ em > = < code > BLE_ATT_ATTR_MAX_LEN</ code >   </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Create a new BLE Characteristic associated with this service. </ 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 of the characteristic. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > properties</ td >< td > - The properties of the characteristic. </ td ></ tr >
2022-07-31 11:38:16 -06:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > max_len</ td >< td > - The maximum length in bytes that the characteristic value can hold. </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > The new BLE characteristic. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aeeaa4b0c543230e7819ad92d48432f5e" name = "aeeaa4b0c543230e7819ad92d48432f5e" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aeeaa4b0c543230e7819ad92d48432f5e" > ◆  </ a ></ span > getCharacteristic() < span class = "overload" > [1/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * NimBLEService::getCharacteristic </ td >
< td > (</ td >
< td class = "paramtype" > const char *  </ td >
< td class = "paramname" >< em > uuid</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint16_t  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > idx</ em > = < code > 0</ code >   </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td ></ td >
< td > )</ td >
2024-12-15 00:45:58 +00:00
< td ></ td >< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Get a pointer to the characteristic object with the specified UUID. </ 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 of the characteristic. </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" ></ td >< td class = "paramname" > idx</ td >< td > The index of the characteristic to return (used when multiple characteristics have the same UUID). </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > A pointer to the characteristic object or nullptr if not found. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a200714f911accd64acfd2fa3d0c6b863" name = "a200714f911accd64acfd2fa3d0c6b863" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a200714f911accd64acfd2fa3d0c6b863" > ◆  </ a ></ span > getCharacteristic() < span class = "overload" > [2/2]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * NimBLEService::getCharacteristic </ 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" > uint16_t  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > idx</ em > = < code > 0</ code >   </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td ></ td >
< td > )</ td >
2024-12-15 00:45:58 +00:00
< td ></ td >< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Get a pointer to the characteristic object with the specified UUID. </ 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 of the characteristic. </ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" ></ td >< td class = "paramname" > idx</ td >< td > The index of the characteristic to return (used when multiple characteristics have the same UUID). </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > A pointer to the characteristic object or nullptr if not found. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a488df9c39d1c49d4b1537abddddb1a7d" name = "a488df9c39d1c49d4b1537abddddb1a7d" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a488df9c39d1c49d4b1537abddddb1a7d" > ◆  </ a ></ span > getCharacteristicByHandle()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * NimBLEService::getCharacteristicByHandle </ td >
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > handle</ em ></ td >< td > )</ td >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Get a pointer to the characteristic object with the specified handle. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > handle</ td >< td > The handle of the characteristic. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > A pointer to the characteristic object or nullptr if not found. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a8219ccefd97180bee485b62572c62e58" name = "a8219ccefd97180bee485b62572c62e58" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a8219ccefd97180bee485b62572c62e58" > ◆  </ a ></ span > getCharacteristics() < span class = "overload" > [1/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > const std::vector< < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * > & NimBLEService::getCharacteristics </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< dl class = "section return" >< dt > Returns</ dt >< dd > A vector containing pointers to each characteristic associated with this service. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a9bb082780665005271fab6e79416f3ed" name = "a9bb082780665005271fab6e79416f3ed" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a9bb082780665005271fab6e79416f3ed" > ◆  </ a ></ span > getCharacteristics() < span class = "overload" > [2/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * > NimBLEService::getCharacteristics </ td >
< td > (</ td >
< td class = "paramtype" > const char *  </ td >
< td class = "paramname" >< em > uuid</ em ></ td >< td > )</ td >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< dl class = "section return" >< dt > Returns</ dt >< dd > A vector containing pointers to each characteristic with the provided UUID associated with this service. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a557ec314a4b2f912b1c1b03e332f9fe1" name = "a557ec314a4b2f912b1c1b03e332f9fe1" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a557ec314a4b2f912b1c1b03e332f9fe1" > ◆  </ a ></ span > getCharacteristics() < span class = "overload" > [3/3]</ span ></ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::vector< < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > * > NimBLEService::getCharacteristics </ 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 >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< dl class = "section return" >< dt > Returns</ dt >< dd > A vector containing pointers to each characteristic with the provided UUID associated with this service. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "acfbb7abadee89abd496b89f8fe085f58" name = "acfbb7abadee89abd496b89f8fe085f58" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#acfbb7abadee89abd496b89f8fe085f58" > ◆  </ a ></ span > getServer()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" >< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer</ a > * NimBLEService::getServer </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Get the BLE server associated with this service. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > The BLEServer associated with this service. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aa9464e97d7e39a4634c5d9bdce1abbac" name = "aa9464e97d7e39a4634c5d9bdce1abbac" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aa9464e97d7e39a4634c5d9bdce1abbac" > ◆  </ a ></ span > isStarted()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > bool NimBLEService::isStarted </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
2024-12-15 00:45:58 +00:00
< p > Checks if the service has been started. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if the service has been started. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "af992d0c27e3a559789fb77fc46623234" name = "af992d0c27e3a559789fb77fc46623234" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#af992d0c27e3a559789fb77fc46623234" > ◆  </ a ></ span > removeCharacteristic()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEService::removeCharacteristic </ td >
< td > (</ td >
< td class = "paramtype" >< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic</ a > *  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > pChar</ em > , </ td >
2021-08-05 01:02:30 +00:00
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > bool  </ td >
< td class = "paramname" >< em > deleteChr</ em > = < code > false</ code >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Remove a characteristic from the service. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
2024-12-15 00:45:58 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > pChar</ td >< td > A pointer to the characteristic instance to remove from the service. </ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > deleteChr</ td >< td > If true it will delete the characteristic instance and free it's resources. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "ad37324ed0404d596923d6fdc0133b985" name = "ad37324ed0404d596923d6fdc0133b985" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ad37324ed0404d596923d6fdc0133b985" > ◆  </ a ></ span > start()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLEService::start </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Builds the database of characteristics/descriptors for the service and registers it with the NimBLE stack. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > bool success/failure . </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a819ff207ef7c30f59887af277aa09ce9" name = "a819ff207ef7c30f59887af277aa09ce9" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a819ff207ef7c30f59887af277aa09ce9" > ◆  </ a ></ span > toString()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > std::string NimBLEService::toString </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
2024-12-15 00:45:58 +00:00
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Return a string representation of this service. A service is defined by: </ p >
< ul >
< li > Its UUID</ li >
< li > Its handle < dl class = "section return" >< dt > Returns</ dt >< dd > A string representation of this service. </ dd ></ dl >
</ li >
</ ul >
</ 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_service.html" > NimBLEService</ a ></ li >
2024-12-15 00:45:58 +00: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 >
2021-08-05 01:02:30 +00:00
</ ul >
</ div >
</ body >
</ html >
