ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-25 04:00:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/class_nim_b_l_e_client_callbacks.html
h2zero 887379cd3f deploy: da48844e2f
2024-12-22 00:10:12 +00:00

570 lines
26 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<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: NimBLEClientCallbacks Class Reference</title>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_nim_b_l_e_client_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">
<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> &#124;
<a href="class_nim_b_l_e_client_callbacks-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">NimBLEClientCallbacks Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Callbacks associated with a BLE client.
<a href="class_nim_b_l_e_client_callbacks.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nim_b_l_e_client_8h_source.html">NimBLEClient.h</a>&gt;</code></p>
<table class="memberdecls">
<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:a96de53d9745f243d544cd89498f979ae" id="r_a96de53d9745f243d544cd89498f979ae"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a96de53d9745f243d544cd89498f979ae">onConnect</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient)</td></tr>
<tr class="memdesc:a96de53d9745f243d544cd89498f979ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after client connects. <br /></td></tr>
<tr class="separator:a96de53d9745f243d544cd89498f979ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0eb6bee07ef8c41dd8924aaca3bc71e" id="r_ad0eb6bee07ef8c41dd8924aaca3bc71e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#ad0eb6bee07ef8c41dd8924aaca3bc71e">onConnectFail</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient, int reason)</td></tr>
<tr class="memdesc:ad0eb6bee07ef8c41dd8924aaca3bc71e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a connection attempt fails. <br /></td></tr>
<tr class="separator:ad0eb6bee07ef8c41dd8924aaca3bc71e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad618179ade926482a7f2d94b0deabd69" id="r_ad618179ade926482a7f2d94b0deabd69"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#ad618179ade926482a7f2d94b0deabd69">onDisconnect</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient, int reason)</td></tr>
<tr class="memdesc:ad618179ade926482a7f2d94b0deabd69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when disconnected from the server. <br /></td></tr>
<tr class="separator:ad618179ade926482a7f2d94b0deabd69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc6a072e1cc974ef084eb2cad18dac6" id="r_a8bc6a072e1cc974ef084eb2cad18dac6"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a8bc6a072e1cc974ef084eb2cad18dac6">onConnParamsUpdateRequest</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient, const ble_gap_upd_params *params)</td></tr>
<tr class="memdesc:a8bc6a072e1cc974ef084eb2cad18dac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when server requests to update the connection parameters. <br /></td></tr>
<tr class="separator:a8bc6a072e1cc974ef084eb2cad18dac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacb0b757e6e7c7984d8389c83fe1937d" id="r_aacb0b757e6e7c7984d8389c83fe1937d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#aacb0b757e6e7c7984d8389c83fe1937d">onPassKeyEntry</a> (<a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;connInfo)</td></tr>
<tr class="memdesc:aacb0b757e6e7c7984d8389c83fe1937d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when server requests a passkey for pairing. <br /></td></tr>
<tr class="separator:aacb0b757e6e7c7984d8389c83fe1937d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8e2abef6949ac87abf5ecad1a4dfe35" id="r_ae8e2abef6949ac87abf5ecad1a4dfe35"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#ae8e2abef6949ac87abf5ecad1a4dfe35">onAuthenticationComplete</a> (<a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;connInfo)</td></tr>
<tr class="memdesc:ae8e2abef6949ac87abf5ecad1a4dfe35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the pairing procedure is complete. <br /></td></tr>
<tr class="separator:ae8e2abef6949ac87abf5ecad1a4dfe35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e7cfa81cd43420f78d6da727c67928b" id="r_a6e7cfa81cd43420f78d6da727c67928b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a6e7cfa81cd43420f78d6da727c67928b">onConfirmPasskey</a> (<a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;connInfo, uint32_t pin)</td></tr>
<tr class="memdesc:a6e7cfa81cd43420f78d6da727c67928b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when using numeric comparision for pairing. <br /></td></tr>
<tr class="separator:a6e7cfa81cd43420f78d6da727c67928b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac03333d26d570e55b285da460c0def76" id="r_ac03333d26d570e55b285da460c0def76"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#ac03333d26d570e55b285da460c0def76">onIdentity</a> (<a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;connInfo)</td></tr>
<tr class="memdesc:ac03333d26d570e55b285da460c0def76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the peer identity address is resolved. <br /></td></tr>
<tr class="separator:ac03333d26d570e55b285da460c0def76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92662eb9ecf882b2c55bc6d9b4de97bc" id="r_a92662eb9ecf882b2c55bc6d9b4de97bc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a92662eb9ecf882b2c55bc6d9b4de97bc">onMTUChange</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient, uint16_t MTU)</td></tr>
<tr class="memdesc:a92662eb9ecf882b2c55bc6d9b4de97bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the connection MTU changes. <br /></td></tr>
<tr class="separator:a92662eb9ecf882b2c55bc6d9b4de97bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e91ebb66e46b7f3ccc6291ece0b549c" id="r_a4e91ebb66e46b7f3ccc6291ece0b549c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_client_callbacks.html#a4e91ebb66e46b7f3ccc6291ece0b549c">onPhyUpdate</a> (<a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *pClient, uint8_t txPhy, uint8_t rxPhy)</td></tr>
<tr class="memdesc:a4e91ebb66e46b7f3ccc6291ece0b549c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the PHY update procedure is complete. <br /></td></tr>
<tr class="separator:a4e91ebb66e46b7f3ccc6291ece0b549c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Callbacks associated with a BLE client. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae8e2abef6949ac87abf5ecad1a4dfe35" name="ae8e2abef6949ac87abf5ecad1a4dfe35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8e2abef6949ac87abf5ecad1a4dfe35">&#9670;&#160;</a></span>onAuthenticationComplete()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onAuthenticationComplete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;&#160;</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 pairing 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 containing the peer info.<br />
This can be used to check the status of the connection encryption/pairing. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6e7cfa81cd43420f78d6da727c67928b" name="a6e7cfa81cd43420f78d6da727c67928b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e7cfa81cd43420f78d6da727c67928b">&#9670;&#160;</a></span>onConfirmPasskey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onConfirmPasskey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;&#160;</td>
<td class="paramname"><em>connInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>pin</em>&#160;</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 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 containing the peer info. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>The pin to compare with the server. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a96de53d9745f243d544cd89498f979ae" name="a96de53d9745f243d544cd89498f979ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96de53d9745f243d544cd89498f979ae">&#9670;&#160;</a></span>onConnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onConnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</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 after client connects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the connecting client object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad0eb6bee07ef8c41dd8924aaca3bc71e" name="ad0eb6bee07ef8c41dd8924aaca3bc71e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0eb6bee07ef8c41dd8924aaca3bc71e">&#9670;&#160;</a></span>onConnectFail()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onConnectFail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>reason</em>&#160;</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 a connection attempt fails. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the connecting client object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reason</td><td>Contains the reason code for the connection failure. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8bc6a072e1cc974ef084eb2cad18dac6" name="a8bc6a072e1cc974ef084eb2cad18dac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bc6a072e1cc974ef084eb2cad18dac6">&#9670;&#160;</a></span>onConnParamsUpdateRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool NimBLEClientCallbacks::onConnParamsUpdateRequest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ble_gap_upd_params *&#160;</td>
<td class="paramname"><em>params</em>&#160;</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 server requests to update the connection parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the calling client object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>A pointer to the struct containing the connection parameters requested. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True to accept the parameters. </dd></dl>
</div>
</div>
<a id="ad618179ade926482a7f2d94b0deabd69" name="ad618179ade926482a7f2d94b0deabd69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad618179ade926482a7f2d94b0deabd69">&#9670;&#160;</a></span>onDisconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onDisconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>reason</em>&#160;</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 disconnected from the server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the calling client object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">reason</td><td>Contains the reason code for the disconnection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac03333d26d570e55b285da460c0def76" name="ac03333d26d570e55b285da460c0def76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac03333d26d570e55b285da460c0def76">&#9670;&#160;</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 NimBLEClientCallbacks::onIdentity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;&#160;</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="a92662eb9ecf882b2c55bc6d9b4de97bc" name="a92662eb9ecf882b2c55bc6d9b4de97bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92662eb9ecf882b2c55bc6d9b4de97bc">&#9670;&#160;</a></span>onMTUChange()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onMTUChange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>MTU</em>&#160;</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 connection MTU changes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pClient</td><td>A pointer to the client that the MTU change is associated with. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">MTU</td><td>The new MTU value. about the peer connection parameters. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aacb0b757e6e7c7984d8389c83fe1937d" name="aacb0b757e6e7c7984d8389c83fe1937d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacb0b757e6e7c7984d8389c83fe1937d">&#9670;&#160;</a></span>onPassKeyEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void NimBLEClientCallbacks::onPassKeyEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> &amp;&#160;</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 server requests a passkey 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 containing the peer info. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4e91ebb66e46b7f3ccc6291ece0b549c" name="a4e91ebb66e46b7f3ccc6291ece0b549c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e91ebb66e46b7f3ccc6291ece0b549c">&#9670;&#160;</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 NimBLEClientCallbacks::onPhyUpdate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td>
<td class="paramname"><em>pClient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>txPhy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rxPhy</em>&#160;</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">pClient</td><td>A pointer to the client whose PHY was updated. 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 -->
</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_client_callbacks.html">NimBLEClientCallbacks</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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink