mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-11-23 13:40:55 +01:00
258 lines
40 KiB
HTML
258 lines
40 KiB
HTML
<!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: src/NimBLEServer.h Source File</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
|
|
 <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&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('_nim_b_l_e_server_8h_source.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="headertitle">
|
|
<div class="title">NimBLEServer.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * NimBLEServer.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Created: on March 2, 2020</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author H2zero</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Originally:</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * BLEServer.h</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Created on: Apr 16, 2017</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Author: kolban</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef MAIN_NIMBLESERVER_H_</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define MAIN_NIMBLESERVER_H_</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "sdkconfig.h"</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#if defined(CONFIG_BT_ENABLED)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="nimconfig_8h.html">nimconfig.h</a>"</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define NIMBLE_ATT_REMOVE_HIDE 1</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define NIMBLE_ATT_REMOVE_DELETE 2</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "NimBLEUtils.h"</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "NimBLEAddress.h"</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "NimBLEAdvertising.h"</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "NimBLEService.h"</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "NimBLESecurity.h"</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "NimBLEConnInfo.h"</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_server.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a> {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_nim_b_l_e_server.html#a98ea12f57c10c0477b0c1c5efab23ee5">getConnectedCount</a>();</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">createService</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">createService</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, uint32_t numHandles=15,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  uint8_t inst_id=0);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a00c92f62f41ec1c499dfaf042b487d75">removeService</a>(<a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* service, <span class="keywordtype">bool</span> deleteSvc = <span class="keyword">false</span>);</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a6eda4c9e0ac1dd031c678d4bf7da1d56">addService</a>(<a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* service);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>* <a class="code" href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">getAdvertising</a>();</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a485c90ce36275f9e4ec26a7f3d348cd9">setCallbacks</a>(<a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>* pCallbacks,</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span> deleteCallbacks = <span class="keyword">true</span>);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a2540ae7b61fc6513f794da2512d66f74">startAdvertising</a>();</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#ab713fd5619ddbfc1a88bf43a1686f454">stopAdvertising</a>();</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#ae94ad52f3c97f62553af9765acdb7bcb">start</a>();</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#a87ebb3d230e98a6b3cf85bc403d227e0">getServiceByUUID</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t instanceId = 0);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#a87ebb3d230e98a6b3cf85bc403d227e0">getServiceByUUID</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, uint16_t instanceId = 0);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>* <a class="code" href="class_nim_b_l_e_server.html#a1ff39fc5235d1374d99b4f3d3acb5ddb">getServiceByHandle</a>(uint16_t handle);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> <a class="code" href="class_nim_b_l_e_server.html#a63c9dce5c4bbc1c6bc720b6c51bcf3e1">disconnect</a>(uint16_t connID,</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  uint8_t reason = BLE_ERR_REM_USER_CONN_TERM);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a9b08738766de90d7065263761314030a">updateConnParams</a>(uint16_t conn_handle,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  uint16_t minInterval, uint16_t maxInterval,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  uint16_t latency, uint16_t timeout);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  uint16_t <a class="code" href="class_nim_b_l_e_server.html#a9eb1f32b72ac93736585d6d89f393021">getPeerMTU</a>(uint16_t conn_id);</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::vector<uint16_t> <a class="code" href="class_nim_b_l_e_server.html#ab95c428ddc94eb019a26d91e70f5974b">getPeerDevices</a>();</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_server.html#a347c74f4ad6e2bcc2e301da11ae13e91">getPeerInfo</a>(<span class="keywordtype">size_t</span> index);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_server.html#a347c74f4ad6e2bcc2e301da11ae13e91">getPeerInfo</a>(<span class="keyword">const</span> <a class="code" href="class_nim_b_l_e_address.html">NimBLEAddress</a>& address);</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a> <a class="code" href="class_nim_b_l_e_server.html#ad241eb42e9775fb2f8aaa87c9fb9a76b">getPeerIDInfo</a>(uint16_t <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server.html#a6bfd923ecd0ea06d5564343ab7209122">advertiseOnDisconnect</a>(<span class="keywordtype">bool</span>);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>();</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  ~<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>();</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_device.html">NimBLEDevice</a>;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a>;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> m_gattsStarted;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> m_advertiseOnDisconnect;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">bool</span> m_svcChanged;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>* m_pServerCallbacks;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">bool</span> m_deleteCallbacks;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  uint16_t m_indWait[<a class="code" href="nimconfig_8h.html#a2ea633774bbf41ac57b314875f16d5f9">CONFIG_BT_NIMBLE_MAX_CONNECTIONS</a>];</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::vector<uint16_t> m_connectedPeersVec;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// uint16_t m_svcChgChrHdl; // Future use</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  std::vector<NimBLEService*> m_svcVec;</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::vector<NimBLECharacteristic*> m_notifyChrVec;</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">static</span> <span class="keywordtype">int</span> handleGapEvent(<span class="keyword">struct</span> ble_gap_event *event, <span class="keywordtype">void</span> *arg);</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> serviceChanged();</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> resetGATT();</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">bool</span> setIndicateWait(uint16_t conn_handle);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> clearIndicateWait(uint16_t conn_handle);</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> }; <span class="comment">// NimBLEServer</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_server_callbacks.html"> 103</a></span> <span class="keyword">class </span><a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a> {</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> ~<a class="code" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a>() {};</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">onConnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer);</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">onConnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer, ble_gap_conn_desc* desc);</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">onDisconnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer);</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">onDisconnect</a>(<a class="code" href="class_nim_b_l_e_server.html">NimBLEServer</a>* pServer, ble_gap_conn_desc* desc);</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#ab4533f1317b36216c3c86695613c80a6">onMTUChange</a>(uint16_t MTU, ble_gap_conn_desc* desc);</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">virtual</span> uint32_t <a class="code" href="class_nim_b_l_e_server_callbacks.html#ad2c3035c3a284d03673ff1b5aeaa0fca">onPassKeyRequest</a>();</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  </div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">//virtual void onPassKeyNotify(uint32_t pass_key);</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="comment">//virtual bool onSecurityRequest();</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a6a18155a8d3fa0980fab51f08ce5de2d">onAuthenticationComplete</a>(ble_gap_conn_desc* desc);</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_nim_b_l_e_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">onConfirmPIN</a>(uint32_t pin);</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> }; <span class="comment">// NimBLEServerCallbacks</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  </div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#endif </span><span class="comment">// #if defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#endif </span><span class="comment">/* MAIN_NIMBLESERVER_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_address_html"><div class="ttname"><a href="class_nim_b_l_e_address.html">NimBLEAddress</a></div><div class="ttdoc">A BLE device address.</div><div class="ttdef"><b>Definition:</b> NimBLEAddress.h:34</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_advertising_html"><div class="ttname"><a href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a></div><div class="ttdoc">Perform and manage BLE advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEAdvertising.h:83</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition:</b> NimBLECharacteristic.h:60</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></div><div class="ttdoc">Connection information.</div><div class="ttdef"><b>Definition:</b> NimBLEConnInfo.h:9</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_device_html"><div class="ttname"><a href="class_nim_b_l_e_device.html">NimBLEDevice</a></div><div class="ttdoc">A model of a BLE Device from which all the BLE roles are created.</div><div class="ttdef"><b>Definition:</b> NimBLEDevice.h:91</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a></div><div class="ttdoc">Callbacks associated with the operation of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:103</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a3dbf72280a895e80e0972599a7373ca0"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a3dbf72280a895e80e0972599a7373ca0">NimBLEServerCallbacks::onDisconnect</a></div><div class="ttdeci">virtual void onDisconnect(NimBLEServer *pServer)</div><div class="ttdoc">Handle a client disconnection. This is called when a client disconnects.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:811</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a5327d11f249e8f020b59529b634e0c91"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a5327d11f249e8f020b59529b634e0c91">NimBLEServerCallbacks::onConfirmPIN</a></div><div class="ttdeci">virtual bool onConfirmPIN(uint32_t pin)</div><div class="ttdoc">Called when using numeric comparision for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:840</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a6a18155a8d3fa0980fab51f08ce5de2d"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a6a18155a8d3fa0980fab51f08ce5de2d">NimBLEServerCallbacks::onAuthenticationComplete</a></div><div class="ttdeci">virtual void onAuthenticationComplete(ble_gap_conn_desc *desc)</div><div class="ttdoc">Called when the pairing procedure is complete.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:837</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_a80348ab2d08bbec7a6910c96662fc1d4"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#a80348ab2d08bbec7a6910c96662fc1d4">NimBLEServerCallbacks::onConnect</a></div><div class="ttdeci">virtual void onConnect(NimBLEServer *pServer)</div><div class="ttdoc">Handle a client connection. This is called when a client connects.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:801</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_ab4533f1317b36216c3c86695613c80a6"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#ab4533f1317b36216c3c86695613c80a6">NimBLEServerCallbacks::onMTUChange</a></div><div class="ttdeci">virtual void onMTUChange(uint16_t MTU, ble_gap_conn_desc *desc)</div><div class="ttdoc">Called when the connection MTU changes.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:819</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_callbacks_html_ad2c3035c3a284d03673ff1b5aeaa0fca"><div class="ttname"><a href="class_nim_b_l_e_server_callbacks.html#ad2c3035c3a284d03673ff1b5aeaa0fca">NimBLEServerCallbacks::onPassKeyRequest</a></div><div class="ttdeci">virtual uint32_t onPassKeyRequest()</div><div class="ttdoc">Called when a client requests a passkey for pairing.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:823</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html"><div class="ttname"><a href="class_nim_b_l_e_server.html">NimBLEServer</a></div><div class="ttdoc">The model of a BLE server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.h:42</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a00c92f62f41ec1c499dfaf042b487d75"><div class="ttname"><a href="class_nim_b_l_e_server.html#a00c92f62f41ec1c499dfaf042b487d75">NimBLEServer::removeService</a></div><div class="ttdeci">void removeService(NimBLEService *service, bool deleteSvc=false)</div><div class="ttdoc">Remove a service from the server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:633</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a1ff39fc5235d1374d99b4f3d3acb5ddb"><div class="ttname"><a href="class_nim_b_l_e_server.html#a1ff39fc5235d1374d99b4f3d3acb5ddb">NimBLEServer::getServiceByHandle</a></div><div class="ttdeci">NimBLEService * getServiceByHandle(uint16_t handle)</div><div class="ttdoc">Get a BLE Service by its handle.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:136</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a2540ae7b61fc6513f794da2512d66f74"><div class="ttname"><a href="class_nim_b_l_e_server.html#a2540ae7b61fc6513f794da2512d66f74">NimBLEServer::startAdvertising</a></div><div class="ttdeci">void startAdvertising()</div><div class="ttdoc">Start advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:727</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a347c74f4ad6e2bcc2e301da11ae13e91"><div class="ttname"><a href="class_nim_b_l_e_server.html#a347c74f4ad6e2bcc2e301da11ae13e91">NimBLEServer::getPeerInfo</a></div><div class="ttdeci">NimBLEConnInfo getPeerInfo(size_t index)</div><div class="ttdoc">Get the connection information of a connected peer by vector index.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:276</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a485c90ce36275f9e4ec26a7f3d348cd9"><div class="ttname"><a href="class_nim_b_l_e_server.html#a485c90ce36275f9e4ec26a7f3d348cd9">NimBLEServer::setCallbacks</a></div><div class="ttdeci">void setCallbacks(NimBLEServerCallbacks *pCallbacks, bool deleteCallbacks=true)</div><div class="ttdoc">Set the server callbacks.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:605</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a63c9dce5c4bbc1c6bc720b6c51bcf3e1"><div class="ttname"><a href="class_nim_b_l_e_server.html#a63c9dce5c4bbc1c6bc720b6c51bcf3e1">NimBLEServer::disconnect</a></div><div class="ttdeci">int disconnect(uint16_t connID, uint8_t reason=BLE_ERR_REM_USER_CONN_TERM)</div><div class="ttdoc">Disconnect the specified client with optional reason.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:232</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a6bfd923ecd0ea06d5564343ab7209122"><div class="ttname"><a href="class_nim_b_l_e_server.html#a6bfd923ecd0ea06d5564343ab7209122">NimBLEServer::advertiseOnDisconnect</a></div><div class="ttdeci">void advertiseOnDisconnect(bool)</div><div class="ttdoc">Set the server to automatically start advertising when a client disconnects.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:250</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a6eda4c9e0ac1dd031c678d4bf7da1d56"><div class="ttname"><a href="class_nim_b_l_e_server.html#a6eda4c9e0ac1dd031c678d4bf7da1d56">NimBLEServer::addService</a></div><div class="ttdeci">void addService(NimBLEService *service)</div><div class="ttdoc">Adds a service which was either already created but removed from availability, or created and later a...</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:669</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a87ebb3d230e98a6b3cf85bc403d227e0"><div class="ttname"><a href="class_nim_b_l_e_server.html#a87ebb3d230e98a6b3cf85bc403d227e0">NimBLEServer::getServiceByUUID</a></div><div class="ttdeci">NimBLEService * getServiceByUUID(const char *uuid, uint16_t instanceId=0)</div><div class="ttdoc">Get a BLE Service by its UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:107</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a98ea12f57c10c0477b0c1c5efab23ee5"><div class="ttname"><a href="class_nim_b_l_e_server.html#a98ea12f57c10c0477b0c1c5efab23ee5">NimBLEServer::getConnectedCount</a></div><div class="ttdeci">size_t getConnectedCount()</div><div class="ttdoc">Return the number of connected clients.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:259</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a9b08738766de90d7065263761314030a"><div class="ttname"><a href="class_nim_b_l_e_server.html#a9b08738766de90d7065263761314030a">NimBLEServer::updateConnParams</a></div><div class="ttdeci">void updateConnParams(uint16_t conn_handle, uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</div><div class="ttdoc">Request an Update the connection parameters:</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:758</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_a9eb1f32b72ac93736585d6d89f393021"><div class="ttname"><a href="class_nim_b_l_e_server.html#a9eb1f32b72ac93736585d6d89f393021">NimBLEServer::getPeerMTU</a></div><div class="ttdeci">uint16_t getPeerMTU(uint16_t conn_id)</div><div class="ttdoc">Get the MTU of the client.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:744</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_aaeb58b4de85754d1aac6964e9248aa35"><div class="ttname"><a href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">NimBLEServer::createService</a></div><div class="ttdeci">NimBLEService * createService(const char *uuid)</div><div class="ttdoc">Create a BLE Service.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:69</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_ab41d8bb9b334734f95a726f1e15200fc"><div class="ttname"><a href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">NimBLEServer::getAdvertising</a></div><div class="ttdeci">NimBLEAdvertising * getAdvertising()</div><div class="ttdoc">Retrieve the advertising object that can be used to advertise the existence of the server.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:150</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_ab713fd5619ddbfc1a88bf43a1686f454"><div class="ttname"><a href="class_nim_b_l_e_server.html#ab713fd5619ddbfc1a88bf43a1686f454">NimBLEServer::stopAdvertising</a></div><div class="ttdeci">void stopAdvertising()</div><div class="ttdoc">Stop advertising.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:735</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_ab95c428ddc94eb019a26d91e70f5974b"><div class="ttname"><a href="class_nim_b_l_e_server.html#ab95c428ddc94eb019a26d91e70f5974b">NimBLEServer::getPeerDevices</a></div><div class="ttdeci">std::vector< uint16_t > getPeerDevices()</div><div class="ttdoc">Get the vector of the connected client ID's.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:267</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_ad241eb42e9775fb2f8aaa87c9fb9a76b"><div class="ttname"><a href="class_nim_b_l_e_server.html#ad241eb42e9775fb2f8aaa87c9fb9a76b">NimBLEServer::getPeerIDInfo</a></div><div class="ttdeci">NimBLEConnInfo getPeerIDInfo(uint16_t id)</div><div class="ttdoc">Get the connection information of a connected peer by connection ID.</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:309</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_server_html_ae94ad52f3c97f62553af9765acdb7bcb"><div class="ttname"><a href="class_nim_b_l_e_server.html#ae94ad52f3c97f62553af9765acdb7bcb">NimBLEServer::start</a></div><div class="ttdeci">void start()</div><div class="ttdoc">Start the GATT server. Required to be called after setup of all services and characteristics / descri...</div><div class="ttdef"><b>Definition:</b> NimBLEServer.cpp:171</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition:</b> NimBLEService.h:36</div></div>
|
|
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a></div><div class="ttdoc">A model of a BLE UUID.</div><div class="ttdef"><b>Definition:</b> NimBLEUUID.h:31</div></div>
|
|
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div>
|
|
<div class="ttc" id="animconfig_8h_html_a2ea633774bbf41ac57b314875f16d5f9"><div class="ttname"><a href="nimconfig_8h.html#a2ea633774bbf41ac57b314875f16d5f9">CONFIG_BT_NIMBLE_MAX_CONNECTIONS</a></div><div class="ttdeci">#define CONFIG_BT_NIMBLE_MAX_CONNECTIONS</div><div class="ttdoc">Un-comment to change the number of simultaneous connections (esp controller max is 9)</div><div class="ttdef"><b>Definition:</b> nimconfig.h:16</div></div>
|
|
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLEServer.h</b></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>
|