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">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2022-01-15 23:23:57 +01:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
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: NimBLESecurityCallbacks 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 >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
2022-01-15 23:23:57 +01:00
< div id = "projectname" > esp-nimble-cpp
2022-10-30 18:19:11 +01:00
  < span id = "projectnumber" > 1.4.1< / span >
2021-08-05 03:02:30 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2022-01-15 23:23:57 +01:00
<!-- Generated by Doxygen 1.9.1 -->
2021-08-05 03:02:30 +02:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_security_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" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "class_nim_b_l_e_security_callbacks-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > NimBLESecurityCallbacks Class Reference< span class = "mlabels" > < span class = "mlabel" > abstract< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Callbacks to handle GAP events related to authorization. < b > Deprecated - provided for backward compatibility only.< / b >
< a href = "class_nim_b_l_e_security_callbacks.html#details" > More...< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a1cfc9c48c02aece1736f9070dc6ff90f" > < 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_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f" > onPassKeyRequest< / a > ()=0< / td > < / tr >
< tr class = "memdesc:a1cfc9c48c02aece1736f9070dc6ff90f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Its request from peer device to input authentication pin code displayed on peer device. It requires that our device is capable to input 6-digits code by end user. < a href = "class_nim_b_l_e_security_callbacks.html#a1cfc9c48c02aece1736f9070dc6ff90f" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a1cfc9c48c02aece1736f9070dc6ff90f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa984ec6f29741b49bdd7dbfde60177be" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be" > onPassKeyNotify< / a > (uint32_t pass_key)=0< / td > < / tr >
< tr class = "memdesc:aa984ec6f29741b49bdd7dbfde60177be" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Provide us 6-digits code to perform authentication. It requires that our device is capable to display this code to end user. < a href = "class_nim_b_l_e_security_callbacks.html#aa984ec6f29741b49bdd7dbfde60177be" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:aa984ec6f29741b49bdd7dbfde60177be" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a620de166c3fe26027871d18535839cdd" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd" > onSecurityRequest< / a > ()=0< / td > < / tr >
< tr class = "memdesc:a620de166c3fe26027871d18535839cdd" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Here we can make decision if we want to let negotiate authorization with peer device or not. < a href = "class_nim_b_l_e_security_callbacks.html#a620de166c3fe26027871d18535839cdd" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a620de166c3fe26027871d18535839cdd" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a22a8079906070a13583daafd1521a125" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a22a8079906070a13583daafd1521a125" > < / a >
virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_security_callbacks.html#a22a8079906070a13583daafd1521a125" > onAuthenticationComplete< / a > (ble_gap_conn_desc *)=0< / td > < / tr >
< tr class = "memdesc:a22a8079906070a13583daafd1521a125" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Provides us information when authentication process is completed. < br / > < / td > < / tr >
< tr class = "separator:a22a8079906070a13583daafd1521a125" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2ce6a03693a43a55e51598d8b2654a92" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92" > onConfirmPIN< / a > (uint32_t pin)=0< / td > < / tr >
< tr class = "memdesc:a2ce6a03693a43a55e51598d8b2654a92" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Called when using numeric comparison for authentication. < a href = "class_nim_b_l_e_security_callbacks.html#a2ce6a03693a43a55e51598d8b2654a92" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a2ce6a03693a43a55e51598d8b2654a92" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Callbacks to handle GAP events related to authorization. < b > Deprecated - provided for backward compatibility only.< / b > < / p >
< dl class = "deprecated" > < dt > < b > < a class = "el" href = "deprecated.html#_deprecated000012" > Deprecated:< / a > < / b > < / dt > < dd > Use the callbacks provided in < a class = "el" href = "class_nim_b_l_e_client_callbacks.html" title = "Callbacks associated with a BLE client." > NimBLEClientCallbacks< / a > and < a class = "el" href = "class_nim_b_l_e_server_callbacks.html" title = "Callbacks associated with the operation of a BLE server." > NimBLEServerCallbacks< / a > instead. < / dd > < / dl >
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a2ce6a03693a43a55e51598d8b2654a92" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2ce6a03693a43a55e51598d8b2654a92" > ◆ < / a > < / span > onConfirmPIN()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool NimBLESecurityCallbacks::onConfirmPIN < / td >
< td > (< / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > pin< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Called when using numeric comparison for authentication. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pin< / td > < td > The PIN to compare. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > True to accept and pair. < / dd > < / dl >
< / div >
< / div >
< a id = "aa984ec6f29741b49bdd7dbfde60177be" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#aa984ec6f29741b49bdd7dbfde60177be" > ◆ < / a > < / span > onPassKeyNotify()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void NimBLESecurityCallbacks::onPassKeyNotify < / td >
< td > (< / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > pass_key< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Provide us 6-digits code to perform authentication. It requires that our device is capable to display this code to end user. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > pass_key< / td > < td > The PIN provided by the peer. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a id = "a1cfc9c48c02aece1736f9070dc6ff90f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a1cfc9c48c02aece1736f9070dc6ff90f" > ◆ < / a > < / span > onPassKeyRequest()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual uint32_t NimBLESecurityCallbacks::onPassKeyRequest < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Its request from peer device to input authentication pin code displayed on peer device. It requires that our device is capable to input 6-digits code by end user. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > Return 6-digits integer value from input device < / dd > < / dl >
< / div >
< / div >
< a id = "a620de166c3fe26027871d18535839cdd" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a620de166c3fe26027871d18535839cdd" > ◆ < / a > < / span > onSecurityRequest()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual bool NimBLESecurityCallbacks::onSecurityRequest < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Here we can make decision if we want to let negotiate authorization with peer device or not. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > Return true if we accept this peer device request < / 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_security_callbacks.html" > NimBLESecurityCallbacks< / a > < / li >
2022-01-15 23:23:57 +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.1 < / li >
2021-08-05 03:02:30 +02:00
< / ul >
< / div >
< / body >
< / html >
