mirror of
https://github.com/h2zero/esp-nimble-cpp.git
synced 2024-12-26 12:40:46 +01:00
215 lines
10 KiB
HTML
215 lines
10 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" 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: NimBLEAttribute 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"> 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&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&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&dn=expat.txt MIT */
|
||
|
|
$(document).ready(function(){initNavTree('class_nim_b_l_e_attribute.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> |
|
||
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
||
|
|
<a href="class_nim_b_l_e_attribute-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">NimBLEAttribute Class Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>A base class for BLE attributes.
|
||
|
|
<a href="class_nim_b_l_e_attribute.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="_nim_b_l_e_attribute_8h_source.html">NimBLEAttribute.h</a>></code></p>
|
||
|
|
|
||
|
|
<p>Inherited by <a class="el" href="class_nim_b_l_e_local_attribute.html">NimBLELocalAttribute</a>, <a class="el" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>, and NimBLERemoteValueAttribute.</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:afd4500e543c9480c52ca994ed5473e49" id="r_afd4500e543c9480c52ca994ed5473e49"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_attribute.html#afd4500e543c9480c52ca994ed5473e49">getUUID</a> () const</td></tr>
|
||
|
|
<tr class="memdesc:afd4500e543c9480c52ca994ed5473e49"><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID of the attribute. <br /></td></tr>
|
||
|
|
<tr class="separator:afd4500e543c9480c52ca994ed5473e49"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7907cb5b0a2d0f8cd9eb016a4ed876d1" id="r_a7907cb5b0a2d0f8cd9eb016a4ed876d1"><td class="memItemLeft" align="right" valign="top"><a id="a7907cb5b0a2d0f8cd9eb016a4ed876d1" name="a7907cb5b0a2d0f8cd9eb016a4ed876d1"></a>
|
||
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><b>getHandle</b> () const</td></tr>
|
||
|
|
<tr class="memdesc:a7907cb5b0a2d0f8cd9eb016a4ed876d1"><td class="mdescLeft"> </td><td class="mdescRight">Get the handle of the attribute. <br /></td></tr>
|
||
|
|
<tr class="separator:a7907cb5b0a2d0f8cd9eb016a4ed876d1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
||
|
|
Protected Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a51ce8e9cd9609f42b9b9248a0b6c642c" id="r_a51ce8e9cd9609f42b9b9248a0b6c642c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_attribute.html#a51ce8e9cd9609f42b9b9248a0b6c642c">NimBLEAttribute</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &uuid, uint16_t handle)</td></tr>
|
||
|
|
<tr class="memdesc:a51ce8e9cd9609f42b9b9248a0b6c642c"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="class_nim_b_l_e_attribute.html" title="A base class for BLE attributes.">NimBLEAttribute</a> object. <br /></td></tr>
|
||
|
|
<tr class="separator:a51ce8e9cd9609f42b9b9248a0b6c642c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8a060f480742cfb09ed47c1f5421d00f" id="r_a8a060f480742cfb09ed47c1f5421d00f"><td class="memItemLeft" align="right" valign="top"><a id="a8a060f480742cfb09ed47c1f5421d00f" name="a8a060f480742cfb09ed47c1f5421d00f"></a>
|
||
|
|
 </td><td class="memItemRight" valign="bottom"><b>~NimBLEAttribute</b> ()=default</td></tr>
|
||
|
|
<tr class="memdesc:a8a060f480742cfb09ed47c1f5421d00f"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the <a class="el" href="class_nim_b_l_e_attribute.html" title="A base class for BLE attributes.">NimBLEAttribute</a> object. <br /></td></tr>
|
||
|
|
<tr class="separator:a8a060f480742cfb09ed47c1f5421d00f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>A base class for BLE attributes. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="a51ce8e9cd9609f42b9b9248a0b6c642c" name="a51ce8e9cd9609f42b9b9248a0b6c642c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51ce8e9cd9609f42b9b9248a0b6c642c">◆ </a></span>NimBLEAttribute()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">NimBLEAttribute::NimBLEAttribute </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & </td>
|
||
|
|
<td class="paramname"><em>uuid</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">uint16_t </td>
|
||
|
|
<td class="paramname"><em>handle</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Construct a new <a class="el" href="class_nim_b_l_e_attribute.html" title="A base class for BLE attributes.">NimBLEAttribute</a> object. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td>The handle of the attribute. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the attribute. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="afd4500e543c9480c52ca994ed5473e49" name="afd4500e543c9480c52ca994ed5473e49"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd4500e543c9480c52ca994ed5473e49">◆ </a></span>getUUID()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> & NimBLEAttribute::getUUID </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the UUID of the attribute. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The UUID. </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_attribute.html">NimBLEAttribute</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>
|