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: NimBLEServerCallbacks 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-06-11 17:19:38 +00:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.3.1</ 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_server_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 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_server_callbacks-members.html" > List of all members</ a > </ div >
2024-12-15 00:45:58 +00:00
< div class = "headertitle" >< div class = "title" > NimBLEServerCallbacks Class Reference</ div ></ div >
2021-08-05 01:02:30 +00:00
</ div > <!--header-->
< div class = "contents" >
< p > Callbacks associated with the operation of a BLE server.
< a href = "class_nim_b_l_e_server_callbacks.html#details" > More...</ a ></ p >
2024-12-15 00:45:58 +00:00
< p >< code > #include < < a class = "el" href = "_nim_b_l_e_server_8h_source.html" > NimBLEServer.h</ a > > </ code ></ 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:a11d48696c2121eb301a76301555df2c5" id = "r_a11d48696c2121eb301a76301555df2c5" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#a11d48696c2121eb301a76301555df2c5" > onConnect</ a > (< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer</ a > *pServer, < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo)</ td ></ tr >
< tr class = "memdesc:a11d48696c2121eb301a76301555df2c5" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Handle a client connection. This is called when a client connects. < br /></ td ></ tr >
< tr class = "separator:a11d48696c2121eb301a76301555df2c5" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a4622b24e5553cc7961c04ab25b63d943" id = "r_a4622b24e5553cc7961c04ab25b63d943" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#a4622b24e5553cc7961c04ab25b63d943" > onDisconnect</ a > (< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer</ a > *pServer, < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo, int reason)</ td ></ tr >
< tr class = "memdesc:a4622b24e5553cc7961c04ab25b63d943" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Handle a client disconnection. This is called when a client disconnects. < br /></ td ></ tr >
< tr class = "separator:a4622b24e5553cc7961c04ab25b63d943" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ab702f73e739b4df72e191f47056c01ff" id = "r_ab702f73e739b4df72e191f47056c01ff" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#ab702f73e739b4df72e191f47056c01ff" > onMTUChange</ a > (uint16_t MTU, < a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo)</ td ></ tr >
< tr class = "memdesc:ab702f73e739b4df72e191f47056c01ff" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when the connection MTU changes. < br /></ td ></ tr >
< tr class = "separator:ab702f73e739b4df72e191f47056c01ff" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a45b5fc1c98b287a2ddeab8f2f5b63c4f" id = "r_a45b5fc1c98b287a2ddeab8f2f5b63c4f" >< td class = "memItemLeft" align = "right" valign = "top" > virtual uint32_t  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#a45b5fc1c98b287a2ddeab8f2f5b63c4f" > onPassKeyDisplay</ a > ()</ td ></ tr >
< tr class = "memdesc:a45b5fc1c98b287a2ddeab8f2f5b63c4f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when a client requests a passkey for pairing (display). < br /></ td ></ tr >
< tr class = "separator:a45b5fc1c98b287a2ddeab8f2f5b63c4f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a507296393ca8557db2e4afa786c5b436" id = "r_a507296393ca8557db2e4afa786c5b436" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#a507296393ca8557db2e4afa786c5b436" > onConfirmPassKey</ a > (< a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo, uint32_t pin)</ td ></ tr >
< tr class = "memdesc:a507296393ca8557db2e4afa786c5b436" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when using numeric comparision for pairing. < br /></ td ></ tr >
< tr class = "separator:a507296393ca8557db2e4afa786c5b436" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a7cbed42919678d9e8d40b351dec82523" id = "r_a7cbed42919678d9e8d40b351dec82523" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#a7cbed42919678d9e8d40b351dec82523" > onAuthenticationComplete</ a > (< a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo)</ td ></ tr >
< tr class = "memdesc:a7cbed42919678d9e8d40b351dec82523" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when the pairing procedure is complete. < br /></ td ></ tr >
< tr class = "separator:a7cbed42919678d9e8d40b351dec82523" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:afa1c14bfba74491e9f57ccaea22b0664" id = "r_afa1c14bfba74491e9f57ccaea22b0664" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#afa1c14bfba74491e9f57ccaea22b0664" > onIdentity</ a > (< a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo)</ td ></ tr >
< tr class = "memdesc:afa1c14bfba74491e9f57ccaea22b0664" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when the peer identity address is resolved. < br /></ td ></ tr >
< tr class = "separator:afa1c14bfba74491e9f57ccaea22b0664" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa6e5e8ef90a537540d9c72f8744c0199" id = "r_aa6e5e8ef90a537540d9c72f8744c0199" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#aa6e5e8ef90a537540d9c72f8744c0199" > onConnParamsUpdate</ a > (< a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo)</ td ></ tr >
< tr class = "memdesc:aa6e5e8ef90a537540d9c72f8744c0199" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when connection parameters are updated following a request to update via < a class = "el" href = "class_nim_b_l_e_server.html#a56add4759f7df045f51b70a026897975" title = "Request an Update the connection parameters:" > NimBLEServer::updateConnParams</ a > . < br /></ td ></ tr >
< tr class = "separator:aa6e5e8ef90a537540d9c72f8744c0199" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a5096aa8ec49fe1eddb5d9ab18c112b22" id = "r_a5096aa8ec49fe1eddb5d9ab18c112b22" >< td class = "memItemLeft" align = "right" valign = "top" > virtual void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "class_nim_b_l_e_server_callbacks.html#a5096aa8ec49fe1eddb5d9ab18c112b22" > onPhyUpdate</ a > (< a class = "el" href = "class_nim_b_l_e_conn_info.html" > NimBLEConnInfo</ a > & connInfo, uint8_t txPhy, uint8_t rxPhy)</ td ></ tr >
< tr class = "memdesc:a5096aa8ec49fe1eddb5d9ab18c112b22" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Called when the PHY update procedure is complete. < br /></ td ></ tr >
< tr class = "separator:a5096aa8ec49fe1eddb5d9ab18c112b22" >< 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 > Callbacks associated with the operation of a BLE server. </ p >
</ div >< h2 class = "groupheader" > Member Function Documentation</ h2 >
2024-12-15 00:45:58 +00:00
< a id = "a7cbed42919678d9e8d40b351dec82523" name = "a7cbed42919678d9e8d40b351dec82523" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a7cbed42919678d9e8d40b351dec82523" > ◆  </ a ></ span > onAuthenticationComplete()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEServerCallbacks::onAuthenticationComplete </ td >
< td > (</ td >
2024-12-15 00:45:58 +00: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 >< td > )</ td >
2021-08-05 01:02:30 +00:00
< 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 > Called when the pairing procedure is complete. </ 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" > 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 with information about the peer connection parameters. </ 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 = "a507296393ca8557db2e4afa786c5b436" name = "a507296393ca8557db2e4afa786c5b436" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a507296393ca8557db2e4afa786c5b436" > ◆  </ a ></ span > onConfirmPassKey()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > void NimBLEServerCallbacks::onConfirmPassKey </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
2024-12-15 00:45:58 +00: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 >
</ tr >
< tr >
< td class = "paramkey" ></ td >
2021-08-05 01:02:30 +00:00
< td ></ td >
2024-12-15 00:45:58 +00:00
< td class = "paramtype" > uint32_t  </ td >
< td class = "paramname" >< em > pin</ em >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
2021-08-05 01:02:30 +00:00
</ tr >
</ table >
</ td >
< td class = "mlabels-right" >
< span class = "mlabels" >< span class = "mlabel" > virtual</ span ></ span > </ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > Called when using numeric comparision for pairing. </ 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" > 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 with information Should be passed back to < a class = "el" href = "class_nim_b_l_e_device.html#aff35384524ab80a19ce1ef23fdcd970b" title = "Inject the provided numeric comparison response into the Security Manager." > NimBLEDevice::injectConfirmPasskey</ a > </ td ></ tr >
2021-08-05 01:02:30 +00:00
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > pin</ td >< td > The pin to compare with the client. </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "a11d48696c2121eb301a76301555df2c5" name = "a11d48696c2121eb301a76301555df2c5" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a11d48696c2121eb301a76301555df2c5" > ◆  </ a ></ span > onConnect()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEServerCallbacks::onConnect </ td >
< td > (</ td >
< td class = "paramtype" >< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer</ a > *  </ td >
< td class = "paramname" >< em > pServer</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
2024-12-15 00:45:58 +00: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 01:02:30 +00: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 > Handle a client connection. This is called when a client connects. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > pServer</ td >< td > A pointer to the BLE server that received the client connection. </ td ></ tr >
2024-12-15 00:45:58 +00: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 with information. about the peer connection parameters.</ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
</ dd >
</ dl >
2024-12-15 00:45:58 +00:00
< p > Default callback handlers </ p >
2021-08-05 01:02:30 +00:00
</ div >
</ div >
2024-12-15 00:45:58 +00:00
< a id = "aa6e5e8ef90a537540d9c72f8744c0199" name = "aa6e5e8ef90a537540d9c72f8744c0199" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#aa6e5e8ef90a537540d9c72f8744c0199" > ◆  </ a ></ span > onConnParamsUpdate()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > void NimBLEServerCallbacks::onConnParamsUpdate </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
2024-12-15 00:45:58 +00: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 >< td > )</ td >
2021-08-05 01:02:30 +00:00
< 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" >
2024-12-15 00:45:58 +00:00
< p > Called when connection parameters are updated following a request to update via < a class = "el" href = "class_nim_b_l_e_server.html#a56add4759f7df045f51b70a026897975" title = "Request an Update the connection parameters:" > NimBLEServer::updateConnParams</ a > . </ p >
2021-08-05 01:02:30 +00:00
< 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" > 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 updated connection parameters. </ 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 = "a4622b24e5553cc7961c04ab25b63d943" name = "a4622b24e5553cc7961c04ab25b63d943" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a4622b24e5553cc7961c04ab25b63d943" > ◆  </ a ></ span > onDisconnect()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEServerCallbacks::onDisconnect </ td >
< td > (</ td >
< td class = "paramtype" >< a class = "el" href = "class_nim_b_l_e_server.html" > NimBLEServer</ a > *  </ td >
< td class = "paramname" >< em > pServer</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
2024-12-15 00:45:58 +00: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 >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > int  </ td >
< td class = "paramname" >< em > reason</ em >   </ td >
2021-08-05 01:02:30 +00: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" >
2024-12-15 00:45:58 +00:00
< p > Handle a client disconnection. This is called when a client disconnects. </ p >
2021-08-05 01:02:30 +00:00
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > pServer</ td >< td > A pointer to the BLE server that received the client disconnection. </ td ></ tr >
2024-12-15 00:45:58 +00: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 with information about the peer connection parameters. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > reason</ td >< td > The reason code for the disconnection. </ 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 = "afa1c14bfba74491e9f57ccaea22b0664" name = "afa1c14bfba74491e9f57ccaea22b0664" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#afa1c14bfba74491e9f57ccaea22b0664" > ◆  </ a ></ span > onIdentity()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEServerCallbacks::onIdentity </ td >
< td > (</ td >
< 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 >< 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 > Called when the peer identity address is resolved. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< 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 with information </ td ></ tr >
</ table >
</ dd >
</ dl >
</ div >
</ div >
< a id = "ab702f73e739b4df72e191f47056c01ff" name = "ab702f73e739b4df72e191f47056c01ff" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#ab702f73e739b4df72e191f47056c01ff" > ◆  </ a ></ span > onMTUChange()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEServerCallbacks::onMTUChange </ td >
< td > (</ td >
< td class = "paramtype" > uint16_t  </ td >
< td class = "paramname" >< em > MTU</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
2024-12-15 00:45:58 +00: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 01:02:30 +00: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 > Called when the connection MTU changes. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > MTU</ td >< td > The new MTU value. </ td ></ tr >
2024-12-15 00:45:58 +00: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 with information about the peer connection parameters. </ 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 = "a45b5fc1c98b287a2ddeab8f2f5b63c4f" name = "a45b5fc1c98b287a2ddeab8f2f5b63c4f" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a45b5fc1c98b287a2ddeab8f2f5b63c4f" > ◆  </ a ></ span > onPassKeyDisplay()</ h2 >
2021-08-05 01:02:30 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-12-15 00:45:58 +00:00
< td class = "memname" > uint32_t NimBLEServerCallbacks::onPassKeyDisplay </ td >
2021-08-05 01:02:30 +00:00
< td > (</ td >
< td class = "paramname" ></ 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" >
2024-12-15 00:45:58 +00:00
< p > Called when a client requests a passkey for pairing (display). </ p >
2021-08-05 01:02:30 +00:00
< dl class = "section return" >< dt > Returns</ dt >< dd > The passkey to be sent to the client. </ dd ></ dl >
2024-12-15 00:45:58 +00:00
</ div >
</ div >
< a id = "a5096aa8ec49fe1eddb5d9ab18c112b22" name = "a5096aa8ec49fe1eddb5d9ab18c112b22" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a5096aa8ec49fe1eddb5d9ab18c112b22" > ◆  </ a ></ span > onPhyUpdate()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void NimBLEServerCallbacks::onPhyUpdate </ td >
< td > (</ td >
< 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 >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > txPhy</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > uint8_t  </ td >
< td class = "paramname" >< em > rxPhy</ 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 > Called when the PHY update procedure is complete. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< 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 with information about the peer connection parameters. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > txPhy</ td >< td > The transmit PHY. </ td ></ tr >
< tr >< td class = "paramdir" > [in]</ td >< td class = "paramname" > rxPhy</ td >< td > The receive PHY. Possible values:< ul >
< li > BLE_GAP_LE_PHY_1M</ li >
< li > BLE_GAP_LE_PHY_2M</ li >
< li > BLE_GAP_LE_PHY_CODED </ li >
</ ul >
</ td ></ tr >
</ table >
</ dd >
</ dl >
2021-08-05 01:02:30 +00:00
</ 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_server_callbacks.html" > NimBLEServerCallbacks</ 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 >
