ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-26 04:30:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_service_8h_source.html
h2zero c47dd827c7 deploy: a6ed1933bc
2024-12-15 00:45:58 +00:00

199 lines
25 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" 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: /github/workspace/src/NimBLEService.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 id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.0</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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('_nim_b_l_e_service_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">
<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="headertitle"><div class="title">NimBLEService.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright 2020-2024 Ryan Powell &lt;ryan@nable-embedded.io&gt; and</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * esp-nimble-cpp, NimBLE-Arduino contributors.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * limitations under the License.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef NIMBLE_CPP_SERVICE_H_</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_SERVICE_H_</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if defined(CONFIG_BT_ENABLED) &amp;&amp; defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor"># include &quot;NimBLEAttribute.h&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor"># include &quot;NimBLEServer.h&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor"># include &quot;NimBLECharacteristic.h&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="};">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_service.html"> 34</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_service.html">NimBLEService</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_nim_b_l_e_local_attribute.html">NimBLELocalAttribute</a> {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_class" href="class_nim_b_l_e_service.html">NimBLEService</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_class" href="class_nim_b_l_e_service.html">NimBLEService</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_function" href="class_nim_b_l_e_service.html#a8904838e785b967c770a240e6c5099e7">~NimBLEService</a>();</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="class_nim_b_l_e_server.html">NimBLEServer</a>* <a class="code hl_function" href="class_nim_b_l_e_service.html#acfbb7abadee89abd496b89f8fe085f58">getServer</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> std::string <a class="code hl_function" href="class_nim_b_l_e_service.html#a819ff207ef7c30f59887af277aa09ce9">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_service.html#a8fafb0c55e447114daf9ad758218905e">dump</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_service.html#aa9464e97d7e39a4634c5d9bdce1abbac">isStarted</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_service.html#ad37324ed0404d596923d6fdc0133b985">start</a>();</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code hl_function" href="class_nim_b_l_e_service.html#a415e1b836946831c6f9edd74adba8763">createCharacteristic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> uint32_t properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code hl_function" href="class_nim_b_l_e_service.html#a415e1b836946831c6f9edd74adba8763">createCharacteristic</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid,</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> uint32_t properties = NIMBLE_PROPERTY::READ | NIMBLE_PROPERTY::WRITE,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> uint16_t max_len = BLE_ATT_ATTR_MAX_LEN);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_service.html#af8215dbfdaf7ced32d6158f8ff5116e8">addCharacteristic</a>(<a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_service.html#af992d0c27e3a559789fb77fc46623234">removeCharacteristic</a>(<a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic, <span class="keywordtype">bool</span> deleteChr = <span class="keyword">false</span>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code hl_function" href="class_nim_b_l_e_service.html#aeeaa4b0c543230e7819ad92d48432f5e">getCharacteristic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t instanceId = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code hl_function" href="class_nim_b_l_e_service.html#aeeaa4b0c543230e7819ad92d48432f5e">getCharacteristic</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid, uint16_t instanceId = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code hl_function" href="class_nim_b_l_e_service.html#a488df9c39d1c49d4b1537abddddb1a7d">getCharacteristicByHandle</a>(uint16_t handle) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> std::vector&lt;NimBLECharacteristic*&gt;&amp; <a class="code hl_function" href="class_nim_b_l_e_service.html#a8219ccefd97180bee485b62572c62e58">getCharacteristics</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::vector&lt;NimBLECharacteristic*&gt; <a class="code hl_function" href="class_nim_b_l_e_service.html#a8219ccefd97180bee485b62572c62e58">getCharacteristics</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> std::vector&lt;NimBLECharacteristic*&gt; <a class="code hl_function" href="class_nim_b_l_e_service.html#a8219ccefd97180bee485b62572c62e58">getCharacteristics</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_server.html">NimBLEServer</a>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> std::vector&lt;NimBLECharacteristic*&gt; m_vChars{};</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// Nimble requires an array of services to be sent to the api</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Since we are adding 1 at a time we create an array of 2 and set the type</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// of the second service to 0 to indicate the end of the array.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> ble_gatt_svc_def m_pSvcDef[2]{};</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>}; <span class="comment">// NimBLEService</span></div>
</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED &amp;&amp; CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="preprocessor">#endif </span><span class="comment">/* NIMBLE_CPP_SERVICE_H_ */</span><span class="preprocessor"></span></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:40</div></div>
<div class="ttc" id="aclass_nim_b_l_e_local_attribute_html"><div class="ttname"><a href="class_nim_b_l_e_local_attribute.html">NimBLELocalAttribute</a></div><div class="ttdoc">A base class for local BLE attributes.</div><div class="ttdef"><b>Definition</b> NimBLELocalAttribute.h:29</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:60</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:34</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a415e1b836946831c6f9edd74adba8763"><div class="ttname"><a href="class_nim_b_l_e_service.html#a415e1b836946831c6f9edd74adba8763">NimBLEService::createCharacteristic</a></div><div class="ttdeci">NimBLECharacteristic * createCharacteristic(const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)</div><div class="ttdoc">Create a new BLE Characteristic associated with this service.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:188</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a488df9c39d1c49d4b1537abddddb1a7d"><div class="ttname"><a href="class_nim_b_l_e_service.html#a488df9c39d1c49d4b1537abddddb1a7d">NimBLEService::getCharacteristicByHandle</a></div><div class="ttdeci">NimBLECharacteristic * getCharacteristicByHandle(uint16_t handle) const</div><div class="ttdoc">Get a pointer to the characteristic object with the specified handle.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:302</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a819ff207ef7c30f59887af277aa09ce9"><div class="ttname"><a href="class_nim_b_l_e_service.html#a819ff207ef7c30f59887af277aa09ce9">NimBLEService::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Return a string representation of this service. A service is defined by:</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:347</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a8219ccefd97180bee485b62572c62e58"><div class="ttname"><a href="class_nim_b_l_e_service.html#a8219ccefd97180bee485b62572c62e58">NimBLEService::getCharacteristics</a></div><div class="ttdeci">const std::vector&lt; NimBLECharacteristic * &gt; &amp; getCharacteristics() const</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:315</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a8904838e785b967c770a240e6c5099e7"><div class="ttname"><a href="class_nim_b_l_e_service.html#a8904838e785b967c770a240e6c5099e7">NimBLEService::~NimBLEService</a></div><div class="ttdeci">~NimBLEService()</div><div class="ttdoc">Destructor, make sure we release the resources allocated for the service.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:51</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_a8fafb0c55e447114daf9ad758218905e"><div class="ttname"><a href="class_nim_b_l_e_service.html#a8fafb0c55e447114daf9ad758218905e">NimBLEService::dump</a></div><div class="ttdeci">void dump() const</div><div class="ttdoc">Dump details of this BLE GATT service.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:67</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_aa9464e97d7e39a4634c5d9bdce1abbac"><div class="ttname"><a href="class_nim_b_l_e_service.html#aa9464e97d7e39a4634c5d9bdce1abbac">NimBLEService::isStarted</a></div><div class="ttdeci">bool isStarted() const</div><div class="ttdoc">Checks if the service has been started.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:368</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_acfbb7abadee89abd496b89f8fe085f58"><div class="ttname"><a href="class_nim_b_l_e_service.html#acfbb7abadee89abd496b89f8fe085f58">NimBLEService::getServer</a></div><div class="ttdeci">NimBLEServer * getServer() const</div><div class="ttdoc">Get the BLE server associated with this service.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:360</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_ad37324ed0404d596923d6fdc0133b985"><div class="ttname"><a href="class_nim_b_l_e_service.html#ad37324ed0404d596923d6fdc0133b985">NimBLEService::start</a></div><div class="ttdeci">bool start()</div><div class="ttdoc">Builds the database of characteristics/descriptors for the service and registers it with the NimBLE s...</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:92</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_aeeaa4b0c543230e7819ad92d48432f5e"><div class="ttname"><a href="class_nim_b_l_e_service.html#aeeaa4b0c543230e7819ad92d48432f5e">NimBLEService::getCharacteristic</a></div><div class="ttdeci">NimBLECharacteristic * getCharacteristic(const char *uuid, uint16_t instanceId=0) const</div><div class="ttdoc">Get a pointer to the characteristic object with the specified UUID.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:273</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_af8215dbfdaf7ced32d6158f8ff5116e8"><div class="ttname"><a href="class_nim_b_l_e_service.html#af8215dbfdaf7ced32d6158f8ff5116e8">NimBLEService::addCharacteristic</a></div><div class="ttdeci">void addCharacteristic(NimBLECharacteristic *pCharacteristic)</div><div class="ttdoc">Add a characteristic to the service.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:213</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html_af992d0c27e3a559789fb77fc46623234"><div class="ttname"><a href="class_nim_b_l_e_service.html#af992d0c27e3a559789fb77fc46623234">NimBLEService::removeCharacteristic</a></div><div class="ttdeci">void removeCharacteristic(NimBLECharacteristic *pCharacteristic, bool deleteChr=false)</div><div class="ttdoc">Remove a characteristic from the service.</div><div class="ttdef"><b>Definition</b> NimBLEService.cpp:245</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:41</div></div>
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></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>NimBLEService.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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink