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: NimBLERemoteCharacteristic 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-05-19 23:04:49 +00:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.3.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_remote_characteristic.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_remote_characteristic-members.html" > List of all members</ a > </ div >
2024-12-15 00:45:58 +00:00
< div class = "headertitle" >< div class = "title" > NimBLERemoteCharacteristic Class Reference</ div ></ div >
2021-08-05 01:02:30 +00:00
</ div > <!--header-->
< div class = "contents" >
< p > A model of a remote BLE characteristic.
< a href = "class_nim_b_l_e_remote_characteristic.html#details" > More...</ a ></ p >
2024-12-15 00:45:58 +00:00
< p >< code > #include < < a class = "el" href = "_nim_b_l_e_remote_characteristic_8h_source.html" > NimBLERemoteCharacteristic.h</ a > > </ code ></ p >
< p > Inherits NimBLERemoteValueAttribute.</ 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:ad77a00c64a83dd58e985e3bbefd87ce2" id = "r_ad77a00c64a83dd58e985e3bbefd87ce2" >< td class = "memItemLeft" align = "right" valign = "top" > std::string  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#ad77a00c64a83dd58e985e3bbefd87ce2" > toString</ a > () const</ td ></ tr >
< tr class = "memdesc:ad77a00c64a83dd58e985e3bbefd87ce2" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Convert a < a class = "el" href = "class_nim_b_l_e_remote_characteristic.html" title = "A model of a remote BLE characteristic." > NimBLERemoteCharacteristic</ a > to a string representation;. < br /></ td ></ tr >
< tr class = "separator:ad77a00c64a83dd58e985e3bbefd87ce2" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a1b3bbd1bcdde6dd952ee69ebad0ffc58" id = "r_a1b3bbd1bcdde6dd952ee69ebad0ffc58" >< td class = "memItemLeft" align = "right" valign = "top" > const < a class = "el" href = "class_nim_b_l_e_remote_service.html" > NimBLERemoteService</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a1b3bbd1bcdde6dd952ee69ebad0ffc58" > getRemoteService</ a > () const</ td ></ tr >
< tr class = "memdesc:a1b3bbd1bcdde6dd952ee69ebad0ffc58" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the remote service associated with this characteristic. < br /></ td ></ tr >
< tr class = "separator:a1b3bbd1bcdde6dd952ee69ebad0ffc58" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a1b021f9ca0501abed573daee878b51eb" id = "r_a1b021f9ca0501abed573daee878b51eb" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a1b021f9ca0501abed573daee878b51eb" > deleteDescriptors</ a > () const</ td ></ tr >
< tr class = "memdesc:a1b021f9ca0501abed573daee878b51eb" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Delete the descriptors in the descriptor vector. < br /></ td ></ tr >
< tr class = "separator:a1b021f9ca0501abed573daee878b51eb" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a03c4da5f5fc36bd5f66c39aed3feb6f2" id = "r_a03c4da5f5fc36bd5f66c39aed3feb6f2" >< td class = "memItemLeft" align = "right" valign = "top" > size_t  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a03c4da5f5fc36bd5f66c39aed3feb6f2" > deleteDescriptor</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid) const</ td ></ tr >
< tr class = "memdesc:a03c4da5f5fc36bd5f66c39aed3feb6f2" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Delete descriptor by UUID. < br /></ td ></ tr >
< tr class = "separator:a03c4da5f5fc36bd5f66c39aed3feb6f2" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0d8e8ae12a89d64d0ca52dd3b3b7c67d" id = "r_a0d8e8ae12a89d64d0ca52dd3b3b7c67d" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a0d8e8ae12a89d64d0ca52dd3b3b7c67d" > canBroadcast</ a > () const</ td ></ tr >
< tr class = "memdesc:a0d8e8ae12a89d64d0ca52dd3b3b7c67d" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support value broadcasting? < br /></ td ></ tr >
< tr class = "separator:a0d8e8ae12a89d64d0ca52dd3b3b7c67d" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a4be19e1a3a82f3db0fa8a7236638b737" id = "r_a4be19e1a3a82f3db0fa8a7236638b737" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a4be19e1a3a82f3db0fa8a7236638b737" > canRead</ a > () const</ td ></ tr >
< tr class = "memdesc:a4be19e1a3a82f3db0fa8a7236638b737" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support reading? < br /></ td ></ tr >
< tr class = "separator:a4be19e1a3a82f3db0fa8a7236638b737" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a0920d576b12ee1e20a724a7da836d153" id = "r_a0920d576b12ee1e20a724a7da836d153" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a0920d576b12ee1e20a724a7da836d153" > canWriteNoResponse</ a > () const</ td ></ tr >
< tr class = "memdesc:a0920d576b12ee1e20a724a7da836d153" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support writing without a response? < br /></ td ></ tr >
< tr class = "separator:a0920d576b12ee1e20a724a7da836d153" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a3ba2263c976bd4ece81a6b37e09fa121" id = "r_a3ba2263c976bd4ece81a6b37e09fa121" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a3ba2263c976bd4ece81a6b37e09fa121" > canWrite</ a > () const</ td ></ tr >
< tr class = "memdesc:a3ba2263c976bd4ece81a6b37e09fa121" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support writing? < br /></ td ></ tr >
< tr class = "separator:a3ba2263c976bd4ece81a6b37e09fa121" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ae3b10383d5b72bdf241bb2f215836772" id = "r_ae3b10383d5b72bdf241bb2f215836772" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#ae3b10383d5b72bdf241bb2f215836772" > canNotify</ a > () const</ td ></ tr >
< tr class = "memdesc:ae3b10383d5b72bdf241bb2f215836772" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support reading with encryption? < br /></ td ></ tr >
< tr class = "separator:ae3b10383d5b72bdf241bb2f215836772" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a79dbe281933d8cab342a5506746b9ded" id = "r_a79dbe281933d8cab342a5506746b9ded" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a79dbe281933d8cab342a5506746b9ded" > canIndicate</ a > () const</ td ></ tr >
< tr class = "memdesc:a79dbe281933d8cab342a5506746b9ded" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support indication? < br /></ td ></ tr >
< tr class = "separator:a79dbe281933d8cab342a5506746b9ded" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:afb07f80d83e41768d228b92210b83657" id = "r_afb07f80d83e41768d228b92210b83657" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#afb07f80d83e41768d228b92210b83657" > canWriteSigned</ a > () const</ td ></ tr >
< tr class = "memdesc:afb07f80d83e41768d228b92210b83657" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support signed writing? < br /></ td ></ tr >
< tr class = "separator:afb07f80d83e41768d228b92210b83657" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aff5a242abcba3f239bd177cebc69e1cb" id = "r_aff5a242abcba3f239bd177cebc69e1cb" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#aff5a242abcba3f239bd177cebc69e1cb" > hasExtendedProps</ a > () const</ td ></ tr >
< tr class = "memdesc:aff5a242abcba3f239bd177cebc69e1cb" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Does the characteristic support extended properties? < br /></ td ></ tr >
< tr class = "separator:aff5a242abcba3f239bd177cebc69e1cb" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:adf445e6bd9dee047a61c708ae943304a" id = "r_adf445e6bd9dee047a61c708ae943304a" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#adf445e6bd9dee047a61c708ae943304a" > subscribe</ a > (bool notifications=true, const notify_callback notifyCallback=nullptr, bool response=true) const</ td ></ tr >
< tr class = "memdesc:adf445e6bd9dee047a61c708ae943304a" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Subscribe for notifications or indications. < br /></ td ></ tr >
< tr class = "separator:adf445e6bd9dee047a61c708ae943304a" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a64a74ffc6612cf4a42f33836e34887f0" id = "r_a64a74ffc6612cf4a42f33836e34887f0" >< td class = "memItemLeft" align = "right" valign = "top" > bool  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a64a74ffc6612cf4a42f33836e34887f0" > unsubscribe</ a > (bool response=true) const</ td ></ tr >
< tr class = "memdesc:a64a74ffc6612cf4a42f33836e34887f0" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Unsubscribe for notifications or indications. < br /></ td ></ tr >
< tr class = "separator:a64a74ffc6612cf4a42f33836e34887f0" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a160cf1b93ae583038606d27b258156e9" id = "r_a160cf1b93ae583038606d27b258156e9" >< td class = "memItemLeft" align = "right" valign = "top" > std::vector< < a class = "el" href = "class_nim_b_l_e_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * > ::iterator  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a160cf1b93ae583038606d27b258156e9" > begin</ a > () const</ td ></ tr >
< tr class = "memdesc:a160cf1b93ae583038606d27b258156e9" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get iterator to the beginning of the vector of remote descriptor pointers. < br /></ td ></ tr >
< tr class = "separator:a160cf1b93ae583038606d27b258156e9" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a17aea026b6a795dbb6bcdc27bbe3d17e" id = "r_a17aea026b6a795dbb6bcdc27bbe3d17e" >< td class = "memItemLeft" align = "right" valign = "top" > std::vector< < a class = "el" href = "class_nim_b_l_e_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * > ::iterator  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a17aea026b6a795dbb6bcdc27bbe3d17e" > end</ a > () const</ td ></ tr >
< tr class = "memdesc:a17aea026b6a795dbb6bcdc27bbe3d17e" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get iterator to the end of the vector of remote descriptor pointers. < br /></ td ></ tr >
< tr class = "separator:a17aea026b6a795dbb6bcdc27bbe3d17e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a8a2e29de02b97c99e88ce1a56e54cdd7" id = "r_a8a2e29de02b97c99e88ce1a56e54cdd7" >< td class = "memItemLeft" align = "right" valign = "top" >< a class = "el" href = "class_nim_b_l_e_remote_descriptor.html" > NimBLERemoteDescriptor</ a > *  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a8a2e29de02b97c99e88ce1a56e54cdd7" > getDescriptor</ a > (const < a class = "el" href = "class_nim_b_l_e_u_u_i_d.html" > NimBLEUUID</ a > & uuid) const</ td ></ tr >
< tr class = "memdesc:a8a2e29de02b97c99e88ce1a56e54cdd7" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get the descriptor instance with the given UUID that belongs to this characteristic. < br /></ td ></ tr >
< tr class = "separator:a8a2e29de02b97c99e88ce1a56e54cdd7" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a27746c8b2405beb1d44567e2c1f85f87" id = "r_a27746c8b2405beb1d44567e2c1f85f87" >< td class = "memItemLeft" align = "right" valign = "top" > const std::vector< < a class = "el" href = "class_nim_b_l_e_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * > &  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_remote_characteristic.html#a27746c8b2405beb1d44567e2c1f85f87" > getDescriptors</ a > (bool refresh=false) const</ td ></ tr >
< tr class = "memdesc:a27746c8b2405beb1d44567e2c1f85f87" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Get a pointer to the vector of found descriptors. < br /></ td ></ tr >
< tr class = "separator:a27746c8b2405beb1d44567e2c1f85f87" >< 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 > A model of a remote BLE characteristic. </ p >
</ div >< h2 class = "groupheader" > Member Function Documentation</ h2 >
2024-12-15 00:45:58 +00:00
< a id = "a160cf1b93ae583038606d27b258156e9" name = "a160cf1b93ae583038606d27b258156e9" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a160cf1b93ae583038606d27b258156e9" > ◆  </ a ></ span > begin()</ 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_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * > ::iterator NimBLERemoteCharacteristic::begin </ 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 iterator to the beginning of the vector of remote descriptor pointers. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > An iterator to the beginning of the vector of remote descriptor pointers. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a0d8e8ae12a89d64d0ca52dd3b3b7c67d" name = "a0d8e8ae12a89d64d0ca52dd3b3b7c67d" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0d8e8ae12a89d64d0ca52dd3b3b7c67d" > ◆  </ a ></ span > canBroadcast()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canBroadcast </ 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" >
2024-12-15 00:45:58 +00:00
< p > Does the characteristic support value broadcasting? </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a79dbe281933d8cab342a5506746b9ded" name = "a79dbe281933d8cab342a5506746b9ded" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a79dbe281933d8cab342a5506746b9ded" > ◆  </ a ></ span > canIndicate()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canIndicate </ 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" >
2024-12-15 00:45:58 +00:00
< p > Does the characteristic support indication? </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "ae3b10383d5b72bdf241bb2f215836772" name = "ae3b10383d5b72bdf241bb2f215836772" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ae3b10383d5b72bdf241bb2f215836772" > ◆  </ a ></ span > canNotify()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canNotify </ 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" >
2024-12-15 00:45:58 +00:00
< p > Does the characteristic support reading with encryption? </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a4be19e1a3a82f3db0fa8a7236638b737" name = "a4be19e1a3a82f3db0fa8a7236638b737" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a4be19e1a3a82f3db0fa8a7236638b737" > ◆  </ a ></ span > canRead()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canRead </ 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 > Does the characteristic support reading? </ p >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a3ba2263c976bd4ece81a6b37e09fa121" name = "a3ba2263c976bd4ece81a6b37e09fa121" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a3ba2263c976bd4ece81a6b37e09fa121" > ◆  </ a ></ span > canWrite()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canWrite </ 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 > Does the characteristic support writing? </ p >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a0920d576b12ee1e20a724a7da836d153" name = "a0920d576b12ee1e20a724a7da836d153" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a0920d576b12ee1e20a724a7da836d153" > ◆  </ a ></ span > canWriteNoResponse()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canWriteNoResponse </ 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" >
2024-12-15 00:45:58 +00:00
< p > Does the characteristic support writing without a response? </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "afb07f80d83e41768d228b92210b83657" name = "afb07f80d83e41768d228b92210b83657" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#afb07f80d83e41768d228b92210b83657" > ◆  </ a ></ span > canWriteSigned()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::canWriteSigned </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td > const</ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Does the characteristic support signed writing? </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
</ div >
</ div >
< a id = "a03c4da5f5fc36bd5f66c39aed3feb6f2" name = "a03c4da5f5fc36bd5f66c39aed3feb6f2" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a03c4da5f5fc36bd5f66c39aed3feb6f2" > ◆  </ a ></ span > deleteDescriptor()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > size_t NimBLERemoteCharacteristic::deleteDescriptor </ 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" >
< p > Delete descriptor by 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 descriptor to be deleted. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > Number of descriptors left in the vector. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a1b021f9ca0501abed573daee878b51eb" name = "a1b021f9ca0501abed573daee878b51eb" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a1b021f9ca0501abed573daee878b51eb" > ◆  </ a ></ span > deleteDescriptors()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLERemoteCharacteristic::deleteDescriptors </ 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 > Delete the descriptors in the descriptor vector. </ p >
2024-12-15 00:45:58 +00:00
< p > We maintain a vector called m_vDescriptors that contains pointers to NimBLERemoteDescriptors object references. Since we allocated these in this class, we are also responsible for deleting them. This method does just that. </ p >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a17aea026b6a795dbb6bcdc27bbe3d17e" name = "a17aea026b6a795dbb6bcdc27bbe3d17e" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a17aea026b6a795dbb6bcdc27bbe3d17e" > ◆  </ a ></ span > end()</ 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_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * > ::iterator NimBLERemoteCharacteristic::end </ 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 iterator to the end of the vector of remote descriptor pointers. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > An iterator to the end of the vector of remote descriptor pointers. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a8a2e29de02b97c99e88ce1a56e54cdd7" name = "a8a2e29de02b97c99e88ce1a56e54cdd7" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a8a2e29de02b97c99e88ce1a56e54cdd7" > ◆  </ a ></ span > getDescriptor()</ 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_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * NimBLERemoteCharacteristic::getDescriptor </ 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" >
< p > Get the descriptor instance with the given UUID that belongs to this characteristic. </ 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 descriptor to find. </ td ></ tr >
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > The Remote descriptor (if present) or nullptr if not present. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a27746c8b2405beb1d44567e2c1f85f87" name = "a27746c8b2405beb1d44567e2c1f85f87" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a27746c8b2405beb1d44567e2c1f85f87" > ◆  </ a ></ span > getDescriptors()</ 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_remote_descriptor.html" > NimBLERemoteDescriptor</ a > * > & NimBLERemoteCharacteristic::getDescriptors </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramtype" > bool  </ td >
< td class = "paramname" >< em > refresh</ em > = < code > false</ code ></ 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 vector of found descriptors. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > refresh</ td >< td > If true the current descriptor vector will be cleared and< br />
all descriptors for this characteristic retrieved from the peripheral.< br />
If false the vector will be returned with the currently stored descriptors of this characteristic. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > A pointer to the vector of descriptors for this characteristic. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a1b3bbd1bcdde6dd952ee69ebad0ffc58" name = "a1b3bbd1bcdde6dd952ee69ebad0ffc58" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a1b3bbd1bcdde6dd952ee69ebad0ffc58" > ◆  </ a ></ span > getRemoteService()</ 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 < a class = "el" href = "class_nim_b_l_e_remote_service.html" > NimBLERemoteService</ a > * NimBLERemoteCharacteristic::getRemoteService </ 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" >
< p > Get the remote service associated with this characteristic. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > The remote service associated with this characteristic. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aff5a242abcba3f239bd177cebc69e1cb" name = "aff5a242abcba3f239bd177cebc69e1cb" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aff5a242abcba3f239bd177cebc69e1cb" > ◆  </ a ></ span > hasExtendedProps()</ 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 NimBLERemoteCharacteristic::hasExtendedProps </ 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 > Does the characteristic support extended properties? </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > True if supported. </ dd ></ dl >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "adf445e6bd9dee047a61c708ae943304a" name = "adf445e6bd9dee047a61c708ae943304a" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#adf445e6bd9dee047a61c708ae943304a" > ◆  </ a ></ span > subscribe()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::subscribe </ td >
< td > (</ td >
< td class = "paramtype" > bool  </ td >
< td class = "paramname" >< em > notifications</ em > = < code > true</ code > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
2024-12-15 00:45:58 +00:00
< td class = "paramtype" > const notify_callback  </ td >
2021-08-05 01:02:30 +00:00
< td class = "paramname" >< em > notifyCallback</ em > = < code > nullptr</ code > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > bool  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > response</ em > = < code > true</ 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 > Subscribe for notifications or indications. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > notifications</ td >< td > If true, subscribe for notifications, false subscribe for indications. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > notifyCallback</ td >< td > A callback to be invoked for a notification. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > response</ td >< td > If true, require a write response from the descriptor write operation. If NULL is provided then no callback is performed. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > false if writing to the descriptor failed. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "ad77a00c64a83dd58e985e3bbefd87ce2" name = "ad77a00c64a83dd58e985e3bbefd87ce2" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ad77a00c64a83dd58e985e3bbefd87ce2" > ◆  </ 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 NimBLERemoteCharacteristic::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 > Convert a < a class = "el" href = "class_nim_b_l_e_remote_characteristic.html" title = "A model of a remote BLE characteristic." > NimBLERemoteCharacteristic</ a > to a string representation;. </ p >
< dl class = "section return" >< dt > Returns</ dt >< dd > a String representation. </ dd ></ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a64a74ffc6612cf4a42f33836e34887f0" name = "a64a74ffc6612cf4a42f33836e34887f0" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a64a74ffc6612cf4a42f33836e34887f0" > ◆  </ a ></ span > unsubscribe()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > bool NimBLERemoteCharacteristic::unsubscribe </ td >
< td > (</ td >
< td class = "paramtype" > bool  </ td >
2024-12-15 00:45:58 +00:00
< td class = "paramname" >< em > response</ em > = < code > true</ code ></ td >< td > )</ td >
< td > const</ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Unsubscribe for notifications or indications. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > response</ td >< td > bool if true, require a write response from the descriptor write operation. </ td ></ tr >
</ table >
</ dd >
</ dl >
< dl class = "section return" >< dt > Returns</ dt >< dd > false if writing to the descriptor failed. </ 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_remote_characteristic.html" > NimBLERemoteCharacteristic</ 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 >
