ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-23 13:40:55 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/class_nim_b_l_e_server_callbacks.html
Deployment Bot (from Travis CI) c51c0f2cf5 Deploy h2zero/esp-nimble-cpp to github.com/h2zero/esp-nimble-cpp.git:gh-pages
2021-08-05 01:02:30 +00:00

438 lines
20 KiB
HTML
Raw 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">
<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.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp / NimBLE-Arduino: NimBLEServerCallbacks 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<span id="projectnumber">1.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<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> &#124;
<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><!--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>
<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:a80348ab2d08bbec7a6910c96662fc1d4"><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_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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a76f32bb22a34b33ee2a934f101d925b1"><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_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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a3dbf72280a895e80e0972599a7373ca0"><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_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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a60e1ad35979434000d04fdbb374acc18"><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_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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ab4533f1317b36216c3c86695613c80a6"><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_server_callbacks.html#ab4533f1317b36216c3c86695613c80a6">onMTUChange</a> (uint16_t MTU, ble_gap_conn_desc *desc)</td></tr>
<tr class="memdesc:ab4533f1317b36216c3c86695613c80a6"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:ad2c3035c3a284d03673ff1b5aeaa0fca"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a6a18155a8d3fa0980fab51f08ce5de2d"><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_server_callbacks.html#a6a18155a8d3fa0980fab51f08ce5de2d">onAuthenticationComplete</a> (ble_gap_conn_desc *desc)</td></tr>
<tr class="memdesc:a6a18155a8d3fa0980fab51f08ce5de2d"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:a5327d11f249e8f020b59529b634e0c91"><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_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">onConfirmPIN</a> (uint32_t pin)</td></tr>
<tr class="memdesc:a5327d11f249e8f020b59529b634e0c91"><td class="mdescLeft">&#160;</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">&#160;</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">&#9670;&nbsp;</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 NimBLEServerCallbacks::onAuthenticationComplete </td>
<td>(</td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</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">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>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5327d11f249e8f020b59529b634e0c91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5327d11f249e8f020b59529b634e0c91">&#9670;&nbsp;</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">bool NimBLEServerCallbacks::onConfirmPIN </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</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">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">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">&#9670;&nbsp;</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> *&#160;</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">&#9670;&nbsp;</a></span>onConnect() <span class="overload">[2/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> *&#160;</td>
<td class="paramname"><em>pServer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</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>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>
<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>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3dbf72280a895e80e0972599a7373ca0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dbf72280a895e80e0972599a7373ca0">&#9670;&nbsp;</a></span>onDisconnect() <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::onDisconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *&#160;</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 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 reference to the BLE server that received the existing client disconnection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a60e1ad35979434000d04fdbb374acc18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60e1ad35979434000d04fdbb374acc18">&#9670;&nbsp;</a></span>onDisconnect() <span class="overload">[2/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::onDisconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a> *&#160;</td>
<td class="paramname"><em>pServer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</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>Handle a client disconnection. This is called when a client discconnects. </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 containig information about the connection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab4533f1317b36216c3c86695613c80a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4533f1317b36216c3c86695613c80a6">&#9670;&nbsp;</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 NimBLEServerCallbacks::onMTUChange </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>MTU</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ble_gap_conn_desc *&#160;</td>
<td class="paramname"><em>desc</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">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 containig information about the connection. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad2c3035c3a284d03673ff1b5aeaa0fca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2c3035c3a284d03673ff1b5aeaa0fca">&#9670;&nbsp;</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">uint32_t NimBLEServerCallbacks::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a client requests a passkey for pairing. </p>
<dl class="section return"><dt>Returns</dt><dd>The passkey to be sent to the client. </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_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.0 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink