2021-08-05 03:02:30 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2024-12-15 01:45:58 +01:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-08-05 03:02:30 +02:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
2024-12-15 01:45:58 +01:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.9.8" / >
2021-08-05 03:02:30 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2022-01-15 23:23:57 +01:00
< title > esp-nimble-cpp: NimBLECharacteristicCallbacks Class Reference< / title >
2021-08-05 03:02:30 +02: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 01:45:58 +01:00
< tr id = "projectrow" >
< td id = "projectalign" >
2024-12-22 01:10:12 +01:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.0.2< / span >
2021-08-05 03:02:30 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2024-12-15 01:45:58 +01:00
<!-- Generated by Doxygen 1.9.8 -->
2021-08-05 03:02:30 +02:00
< script type = "text/javascript" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
2021-08-05 03:02:30 +02:00
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2021-08-05 03:02:30 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2024-12-15 01:45:58 +01:00
/* @license-end */
< / script >
2021-08-05 03:02:30 +02:00
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
2024-12-15 01:45:58 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2021-08-05 03:02:30 +02:00
$(document).ready(function(){initNavTree('class_nim_b_l_e_characteristic_callbacks.html',''); initResizable(); });
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
2024-12-15 01:45:58 +01:00
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
2021-08-05 03:02:30 +02:00
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "class_nim_b_l_e_characteristic_callbacks-members.html" > List of all members< / a > < / div >
2024-12-15 01:45:58 +01:00
< div class = "headertitle" > < div class = "title" > NimBLECharacteristicCallbacks Class Reference< / div > < / div >
2021-08-05 03:02:30 +02:00
< / div > <!-- header -->
< div class = "contents" >
< p > Callbacks that can be associated with a BLE characteristic to inform of events.
< a href = "class_nim_b_l_e_characteristic_callbacks.html#details" > More...< / a > < / p >
2024-12-15 01:45:58 +01:00
< p > < code > #include < < a class = "el" href = "_nim_b_l_e_characteristic_8h_source.html" > NimBLECharacteristic.h< / a > > < / code > < / p >
2021-08-05 03:02:30 +02:00
< table class = "memberdecls" >
2024-12-15 01:45:58 +01:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-methods" name = "pub-methods" > < / a >
2021-08-05 03:02:30 +02:00
Public Member Functions< / h2 > < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr class = "memitem:a120d3dade06fbc941a93edbdc0e4d830" id = "r_a120d3dade06fbc941a93edbdc0e4d830" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_characteristic_callbacks.html#a120d3dade06fbc941a93edbdc0e4d830" > onRead< / a > (< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *pCharacteristic, < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo< / a > & connInfo)< / td > < / tr >
< tr class = "memdesc:a120d3dade06fbc941a93edbdc0e4d830" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Callback function to support a read request. < br / > < / td > < / tr >
< tr class = "separator:a120d3dade06fbc941a93edbdc0e4d830" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab4edbb758f0212fd190dedad6c9b8ec9" id = "r_ab4edbb758f0212fd190dedad6c9b8ec9" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_characteristic_callbacks.html#ab4edbb758f0212fd190dedad6c9b8ec9" > onWrite< / a > (< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *pCharacteristic, < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo< / a > & connInfo)< / td > < / tr >
< tr class = "memdesc:ab4edbb758f0212fd190dedad6c9b8ec9" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Callback function to support a write request. < br / > < / td > < / tr >
< tr class = "separator:ab4edbb758f0212fd190dedad6c9b8ec9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a6f9b1f0f15492e3d47662e5e2ff0baee" id = "r_a6f9b1f0f15492e3d47662e5e2ff0baee" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_characteristic_callbacks.html#a6f9b1f0f15492e3d47662e5e2ff0baee" > onStatus< / a > (< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *pCharacteristic, int code)< / td > < / tr >
< tr class = "memdesc:a6f9b1f0f15492e3d47662e5e2ff0baee" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Callback function to support a Notify/Indicate Status report. < br / > < / td > < / tr >
< tr class = "separator:a6f9b1f0f15492e3d47662e5e2ff0baee" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a024951384bb777d7ee71bfd1d5eff185" id = "r_a024951384bb777d7ee71bfd1d5eff185" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_characteristic_callbacks.html#a024951384bb777d7ee71bfd1d5eff185" > onSubscribe< / a > (< a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *pCharacteristic, < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo< / a > & connInfo, uint16_t subValue)< / td > < / tr >
< tr class = "memdesc:a024951384bb777d7ee71bfd1d5eff185" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Callback function called when a client changes subscription status. < br / > < / td > < / tr >
< tr class = "separator:a024951384bb777d7ee71bfd1d5eff185" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Callbacks that can be associated with a BLE characteristic to inform of events. < / p >
< p > When a server application creates a BLE characteristic, we may wish to be informed when there is either a read or write request to the characteristic's value. An application can register a sub-classed instance of this class and will be notified when such an event happens. < / p >
2024-12-15 01:45:58 +01:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a120d3dade06fbc941a93edbdc0e4d830" name = "a120d3dade06fbc941a93edbdc0e4d830" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a120d3dade06fbc941a93edbdc0e4d830" > ◆   < / a > < / span > onRead()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLECharacteristicCallbacks::onRead < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *  < / td >
< td class = "paramname" > < em > pCharacteristic< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo< / a > &   < / td >
< td class = "paramname" > < em > connInfo< / em >   < / td >
2021-08-05 03:02:30 +02:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Callback function to support a read request. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pCharacteristic< / td > < td > The characteristic that is the source of the event. < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > connInfo< / td > < td > A reference to a < a class = "el" href = "class_nim_b_l_e_conn_info.html" title = "Connection information." > NimBLEConnInfo< / a > instance containing the peer info. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "a6f9b1f0f15492e3d47662e5e2ff0baee" name = "a6f9b1f0f15492e3d47662e5e2ff0baee" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a6f9b1f0f15492e3d47662e5e2ff0baee" > ◆   < / a > < / span > onStatus()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLECharacteristicCallbacks::onStatus < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *  < / td >
< td class = "paramname" > < em > pCharacteristic< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > code< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Callback function to support a Notify/Indicate Status report. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pCharacteristic< / td > < td > The characteristic that is the source of the event. < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > code< / td > < td > Status return code from the NimBLE stack.< / td > < / tr >
2021-08-05 03:02:30 +02:00
< / table >
< / dd >
< / dl >
2024-12-15 01:45:58 +01:00
< p > The status code for success is 0 for notifications and BLE_HS_EDONE for indications, any other value is an error. < / p >
2021-08-05 03:02:30 +02:00
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "a024951384bb777d7ee71bfd1d5eff185" name = "a024951384bb777d7ee71bfd1d5eff185" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a024951384bb777d7ee71bfd1d5eff185" > ◆   < / a > < / span > onSubscribe()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLECharacteristicCallbacks::onSubscribe < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *  < / td >
< td class = "paramname" > < em > pCharacteristic< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo< / a > &   < / td >
< td class = "paramname" > < em > connInfo< / em > , < / td >
2021-08-05 03:02:30 +02:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > subValue< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Callback function called when a client changes subscription status. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pCharacteristic< / td > < td > The characteristic that is the source of the event. < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > connInfo< / td > < td > A reference to a < a class = "el" href = "class_nim_b_l_e_conn_info.html" title = "Connection information." > NimBLEConnInfo< / a > instance containing the peer info. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > subValue< / td > < td > The subscription status:< ul >
< li > 0 = Un-Subscribed< / li >
< li > 1 = Notifications< / li >
< li > 2 = Indications< / li >
< li > 3 = Notifications and Indications < / li >
< / ul >
< / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2024-12-15 01:45:58 +01:00
< a id = "ab4edbb758f0212fd190dedad6c9b8ec9" name = "ab4edbb758f0212fd190dedad6c9b8ec9" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ab4edbb758f0212fd190dedad6c9b8ec9" > ◆   < / a > < / span > onWrite()< / h2 >
2021-08-05 03:02:30 +02:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLECharacteristicCallbacks::onWrite < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_characteristic.html" > NimBLECharacteristic< / a > *  < / td >
< td class = "paramname" > < em > pCharacteristic< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-12-15 01:45:58 +01:00
< td class = "paramtype" > < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo< / a > &   < / td >
< td class = "paramname" > < em > connInfo< / em >   < / td >
2021-08-05 03:02:30 +02:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Callback function to support a write request. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pCharacteristic< / td > < td > The characteristic that is the source of the event. < / td > < / tr >
2024-12-15 01:45:58 +01:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > connInfo< / td > < td > A reference to a < a class = "el" href = "class_nim_b_l_e_conn_info.html" title = "Connection information." > NimBLEConnInfo< / a > instance containing the peer info. < / td > < / tr >
2021-08-05 03:02:30 +02:00
< / 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_characteristic_callbacks.html" > NimBLECharacteristicCallbacks< / a > < / li >
2024-12-15 01:45:58 +01:00
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.9.8 < / li >
2021-08-05 03:02:30 +02:00
< / ul >
< / div >
< / body >
< / html >
