forked from h2zero/esp-nimble-cpp
deploy: a6ed1933bc
This commit is contained in:
1 parent
73d39b0a88
commit
c47dd827c7
378 files changed
+23543
-22876
No files matched your search
@@ -1,9 +1,9 @@
|
||||
<!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">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.9.1"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>esp-nimble-cpp: NimBLEServerCallbacks Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -23,10 +23,9 @@
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">esp-nimble-cpp
|
||||
 <span id="projectnumber">1.4.1</span>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">esp-nimble-cpp<span id="projectnumber"> 2.0.0</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -34,21 +33,22 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.1 -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<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 magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "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 */
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */</script>
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
@@ -62,7 +62,7 @@ $(function() {
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function(){initNavTree('class_nim_b_l_e_server_callbacks.html',''); initResizable(); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
@@ -76,55 +76,66 @@ $(document).ready(function(){initNavTree('class_nim_b_l_e_server_callbacks.html'
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<iframe src="javascript:void(0)" frameborder="0"
|
||||
name="MSearchResults" id="MSearchResults">
|
||||
</iframe>
|
||||
<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>
|
||||
</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>
|
||||
<div class="headertitle">
|
||||
<div class="title">NimBLEServerCallbacks Class Reference</div> </div>
|
||||
<div class="headertitle"><div class="title">NimBLEServerCallbacks Class Reference</div></div>
|
||||
</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>
|
||||
|
||||
<p><code>#include <<a class="el" href="_nim_b_l_e_server_8h_source.html">NimBLEServer.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a80348ab2d08bbec7a6910c96662fc1d4"><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#a80348ab2d08bbec7a6910c96662fc1d4">onConnect</a> (<a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *pServer)</td></tr>
|
||||
<tr class="memdesc:a80348ab2d08bbec7a6910c96662fc1d4"><td class="mdescLeft"> </td><td class="mdescRight">Handle a client connection. This is called when a client connects. <a href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">More...</a><br /></td></tr>
|
||||
<tr class="separator:a80348ab2d08bbec7a6910c96662fc1d4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a76f32bb22a34b33ee2a934f101d925b1"><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#a76f32bb22a34b33ee2a934f101d925b1">onConnect</a> (<a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *pServer, ble_gap_conn_desc *desc)</td></tr>
|
||||
<tr class="memdesc:a76f32bb22a34b33ee2a934f101d925b1"><td class="mdescLeft"> </td><td class="mdescRight">Handle a client connection. This is called when a client connects. <a href="class_nim_b_l_e_server_callbacks.html#a76f32bb22a34b33ee2a934f101d925b1">More...</a><br /></td></tr>
|
||||
<tr class="separator:a76f32bb22a34b33ee2a934f101d925b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3dbf72280a895e80e0972599a7373ca0"><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#a3dbf72280a895e80e0972599a7373ca0">onDisconnect</a> (<a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *pServer)</td></tr>
|
||||
<tr class="memdesc:a3dbf72280a895e80e0972599a7373ca0"><td class="mdescLeft"> </td><td class="mdescRight">Handle a client disconnection. This is called when a client disconnects. <a href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">More...</a><br /></td></tr>
|
||||
<tr class="separator:a3dbf72280a895e80e0972599a7373ca0"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a60e1ad35979434000d04fdbb374acc18"><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#a60e1ad35979434000d04fdbb374acc18">onDisconnect</a> (<a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *pServer, ble_gap_conn_desc *desc)</td></tr>
|
||||
<tr class="memdesc:a60e1ad35979434000d04fdbb374acc18"><td class="mdescLeft"> </td><td class="mdescRight">Handle a client disconnection. This is called when a client discconnects. <a href="class_nim_b_l_e_server_callbacks.html#a60e1ad35979434000d04fdbb374acc18">More...</a><br /></td></tr>
|
||||
<tr class="separator:a60e1ad35979434000d04fdbb374acc18"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab4533f1317b36216c3c86695613c80a6"><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#ab4533f1317b36216c3c86695613c80a6">onMTUChange</a> (uint16_t MTU, ble_gap_conn_desc *desc)</td></tr>
|
||||
<tr class="memdesc:ab4533f1317b36216c3c86695613c80a6"><td class="mdescLeft"> </td><td class="mdescRight">Called when the connection MTU changes. <a href="class_nim_b_l_e_server_callbacks.html#ab4533f1317b36216c3c86695613c80a6">More...</a><br /></td></tr>
|
||||
<tr class="separator:ab4533f1317b36216c3c86695613c80a6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad2c3035c3a284d03673ff1b5aeaa0fca"><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#ad2c3035c3a284d03673ff1b5aeaa0fca">onPassKeyRequest</a> ()</td></tr>
|
||||
<tr class="memdesc:ad2c3035c3a284d03673ff1b5aeaa0fca"><td class="mdescLeft"> </td><td class="mdescRight">Called when a client requests a passkey for pairing. <a href="class_nim_b_l_e_server_callbacks.html#ad2c3035c3a284d03673ff1b5aeaa0fca">More...</a><br /></td></tr>
|
||||
<tr class="separator:ad2c3035c3a284d03673ff1b5aeaa0fca"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6a18155a8d3fa0980fab51f08ce5de2d"><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#a6a18155a8d3fa0980fab51f08ce5de2d">onAuthenticationComplete</a> (ble_gap_conn_desc *desc)</td></tr>
|
||||
<tr class="memdesc:a6a18155a8d3fa0980fab51f08ce5de2d"><td class="mdescLeft"> </td><td class="mdescRight">Called when the pairing procedure is complete. <a href="class_nim_b_l_e_server_callbacks.html#a6a18155a8d3fa0980fab51f08ce5de2d">More...</a><br /></td></tr>
|
||||
<tr class="separator:a6a18155a8d3fa0980fab51f08ce5de2d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5327d11f249e8f020b59529b634e0c91"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">onConfirmPIN</a> (uint32_t pin)</td></tr>
|
||||
<tr class="memdesc:a5327d11f249e8f020b59529b634e0c91"><td class="mdescLeft"> </td><td class="mdescRight">Called when using numeric comparision for pairing. <a href="class_nim_b_l_e_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">More...</a><br /></td></tr>
|
||||
<tr class="separator:a5327d11f249e8f020b59529b634e0c91"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<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>
|
||||
</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>
|
||||
<a id="a6a18155a8d3fa0980fab51f08ce5de2d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6a18155a8d3fa0980fab51f08ce5de2d">◆ </a></span>onAuthenticationComplete()</h2>
|
||||
<a id="a7cbed42919678d9e8d40b351dec82523" name="a7cbed42919678d9e8d40b351dec82523"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7cbed42919678d9e8d40b351dec82523">◆ </a></span>onAuthenticationComplete()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -135,8 +146,8 @@ Public Member Functions</h2></td></tr>
|
||||
<tr>
|
||||
<td class="memname">void NimBLEServerCallbacks::onAuthenticationComplete </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">ble_gap_conn_desc * </td>
|
||||
<td class="paramname"><em>desc</em></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>
|
||||
@@ -150,16 +161,15 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Called when the pairing procedure is complete. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>A pointer to the struct containing the connection information.<br />
|
||||
This can be used to check the status of the connection encryption/pairing. </td></tr>
|
||||
<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>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a5327d11f249e8f020b59529b634e0c91"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a5327d11f249e8f020b59529b634e0c91">◆ </a></span>onConfirmPIN()</h2>
|
||||
<a id="a507296393ca8557db2e4afa786c5b436" name="a507296393ca8557db2e4afa786c5b436"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a507296393ca8557db2e4afa786c5b436">◆ </a></span>onConfirmPassKey()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -168,11 +178,21 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool NimBLEServerCallbacks::onConfirmPIN </td>
|
||||
<td class="memname">void NimBLEServerCallbacks::onConfirmPassKey </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">uint32_t </td>
|
||||
<td class="paramname"><em>pin</em></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">uint32_t </td>
|
||||
<td class="paramname"><em>pin</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
@@ -185,51 +205,16 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<p>Called when using numeric comparision for pairing. </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 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>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>The pin to compare with the client. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>True to accept the pin. </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a80348ab2d08bbec7a6910c96662fc1d4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a80348ab2d08bbec7a6910c96662fc1d4">◆ </a></span>onConnect() <span class="overload">[1/2]</span></h2>
|
||||
|
||||
<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><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>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Default callback handlers </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a76f32bb22a34b33ee2a934f101d925b1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a76f32bb22a34b33ee2a934f101d925b1">◆ </a></span>onConnect() <span class="overload">[2/2]</span></h2>
|
||||
<a id="a11d48696c2121eb301a76301555df2c5" name="a11d48696c2121eb301a76301555df2c5"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a11d48696c2121eb301a76301555df2c5">◆ </a></span>onConnect()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -246,8 +231,8 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">ble_gap_conn_desc * </td>
|
||||
<td class="paramname"><em>desc</em> </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></td>
|
||||
@@ -266,15 +251,16 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<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>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>A pointer to the connection description structure containig information about the connection parameters. </td></tr>
|
||||
<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>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>Default callback handlers </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a3dbf72280a895e80e0972599a7373ca0"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3dbf72280a895e80e0972599a7373ca0">◆ </a></span>onDisconnect() <span class="overload">[1/2]</span></h2>
|
||||
<a id="aa6e5e8ef90a537540d9c72f8744c0199" name="aa6e5e8ef90a537540d9c72f8744c0199"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa6e5e8ef90a537540d9c72f8744c0199">◆ </a></span>onConnParamsUpdate()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -283,10 +269,10 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void NimBLEServerCallbacks::onDisconnect </td>
|
||||
<td class="memname">void NimBLEServerCallbacks::onConnParamsUpdate </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><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>
|
||||
@@ -297,18 +283,18 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Handle a client disconnection. This is called when a client disconnects. </p>
|
||||
<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>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">pServer</td><td>A reference to the BLE server that received the existing client disconnection. </td></tr>
|
||||
<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>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a60e1ad35979434000d04fdbb374acc18"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a60e1ad35979434000d04fdbb374acc18">◆ </a></span>onDisconnect() <span class="overload">[2/2]</span></h2>
|
||||
<a id="a4622b24e5553cc7961c04ab25b63d943" name="a4622b24e5553cc7961c04ab25b63d943"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a4622b24e5553cc7961c04ab25b63d943">◆ </a></span>onDisconnect()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -325,8 +311,14 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">ble_gap_conn_desc * </td>
|
||||
<td class="paramname"><em>desc</em> </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">int </td>
|
||||
<td class="paramname"><em>reason</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
@@ -341,19 +333,54 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Handle a client disconnection. This is called when a client discconnects. </p>
|
||||
<p>Handle a client disconnection. This is called when a client disconnects. </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 disconnection. </td></tr>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>A pointer to the connection description structure containing information about the connection. </td></tr>
|
||||
<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>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab4533f1317b36216c3c86695613c80a6"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab4533f1317b36216c3c86695613c80a6">◆ </a></span>onMTUChange()</h2>
|
||||
<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>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -370,8 +397,8 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">ble_gap_conn_desc * </td>
|
||||
<td class="paramname"><em>desc</em> </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></td>
|
||||
@@ -390,15 +417,15 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<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>
|
||||
<tr><td class="paramdir">[in]</td><td class="paramname">desc</td><td>A pointer to the connection description structure containing information about the connection. </td></tr>
|
||||
<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>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad2c3035c3a284d03673ff1b5aeaa0fca"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad2c3035c3a284d03673ff1b5aeaa0fca">◆ </a></span>onPassKeyRequest()</h2>
|
||||
<a id="a45b5fc1c98b287a2ddeab8f2f5b63c4f" name="a45b5fc1c98b287a2ddeab8f2f5b63c4f"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a45b5fc1c98b287a2ddeab8f2f5b63c4f">◆ </a></span>onPassKeyDisplay()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -407,7 +434,7 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t NimBLEServerCallbacks::onPassKeyRequest </td>
|
||||
<td class="memname">uint32_t NimBLEServerCallbacks::onPassKeyDisplay </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td></td>
|
||||
@@ -420,9 +447,66 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Called when a client requests a passkey for pairing. </p>
|
||||
<p>Called when a client requests a passkey for pairing (display). </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>The passkey to be sent to the client. </dd></dl>
|
||||
|
||||
</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>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
@@ -431,7 +515,7 @@ This can be used to check the status of the connection encryption/pairing. </td>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in new issue
Block a user