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/class_nim_b_l_e_remote_service.html
h2zero c47dd827c7 deploy: a6ed1933bc
2024-12-15 00:45:58 +00:00

449 lines
28 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: NimBLERemoteService Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_nim_b_l_e_remote_service.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_remote_service-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">NimBLERemoteService Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A model of a remote BLE service.
<a href="class_nim_b_l_e_remote_service.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nim_b_l_e_remote_service_8h_source.html">NimBLERemoteService.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="class_nim_b_l_e_attribute.html">NimBLEAttribute</a>.</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:ae10ddb56bc48bd06538ab49e4a561594" id="r_ae10ddb56bc48bd06538ab49e4a561594"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#ae10ddb56bc48bd06538ab49e4a561594">getCharacteristic</a> (const char *uuid) const</td></tr>
<tr class="memdesc:ae10ddb56bc48bd06538ab49e4a561594"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the remote characteristic object for the characteristic UUID. <br /></td></tr>
<tr class="separator:ae10ddb56bc48bd06538ab49e4a561594"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a404ee02ca3ecf8c9d244029ede066bda" id="r_a404ee02ca3ecf8c9d244029ede066bda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a404ee02ca3ecf8c9d244029ede066bda">getCharacteristic</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid) const</td></tr>
<tr class="memdesc:a404ee02ca3ecf8c9d244029ede066bda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the characteristic object for the UUID. <br /></td></tr>
<tr class="separator:a404ee02ca3ecf8c9d244029ede066bda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7248e58b58753d8b44c420617d854408" id="r_a7248e58b58753d8b44c420617d854408"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a7248e58b58753d8b44c420617d854408">deleteCharacteristics</a> () const</td></tr>
<tr class="memdesc:a7248e58b58753d8b44c420617d854408"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the characteristics in the characteristics vector. <br /></td></tr>
<tr class="separator:a7248e58b58753d8b44c420617d854408"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a828d57a4691d25e9e0e6124c3b0f1ac2" id="r_a828d57a4691d25e9e0e6124c3b0f1ac2"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a828d57a4691d25e9e0e6124c3b0f1ac2">deleteCharacteristic</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid) const</td></tr>
<tr class="memdesc:a828d57a4691d25e9e0e6124c3b0f1ac2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete characteristic by UUID. <br /></td></tr>
<tr class="separator:a828d57a4691d25e9e0e6124c3b0f1ac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f56031169ebeefcd834fff971a972c2" id="r_a2f56031169ebeefcd834fff971a972c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a2f56031169ebeefcd834fff971a972c2">getClient</a> (void) const</td></tr>
<tr class="memdesc:a2f56031169ebeefcd834fff971a972c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the client associated with this service. <br /></td></tr>
<tr class="separator:a2f56031169ebeefcd834fff971a972c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2f19f76f0c0ac9b0efe2baa2ad2f7ec" id="r_ac2f19f76f0c0ac9b0efe2baa2ad2f7ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#ac2f19f76f0c0ac9b0efe2baa2ad2f7ec">getValue</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUuid) const</td></tr>
<tr class="memdesc:ac2f19f76f0c0ac9b0efe2baa2ad2f7ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the value of a characteristic associated with this service. <br /></td></tr>
<tr class="separator:ac2f19f76f0c0ac9b0efe2baa2ad2f7ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d571db36b8af93b35d44f7cf4afa5ed" id="r_a0d571db36b8af93b35d44f7cf4afa5ed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a0d571db36b8af93b35d44f7cf4afa5ed">setValue</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;characteristicUuid, const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &amp;value) const</td></tr>
<tr class="memdesc:a0d571db36b8af93b35d44f7cf4afa5ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of a characteristic. <br /></td></tr>
<tr class="separator:a0d571db36b8af93b35d44f7cf4afa5ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a347e848039121cbf3005349f9aa50680" id="r_a347e848039121cbf3005349f9aa50680"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a347e848039121cbf3005349f9aa50680">toString</a> (void) const</td></tr>
<tr class="memdesc:a347e848039121cbf3005349f9aa50680"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a string representation of this remote service. <br /></td></tr>
<tr class="separator:a347e848039121cbf3005349f9aa50680"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b07f0756c401d40396886e80d64b03b" id="r_a5b07f0756c401d40396886e80d64b03b"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a5b07f0756c401d40396886e80d64b03b">getCharacteristics</a> (bool refresh=false) const</td></tr>
<tr class="memdesc:a5b07f0756c401d40396886e80d64b03b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the vector of found characteristics. <br /></td></tr>
<tr class="separator:a5b07f0756c401d40396886e80d64b03b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e6d6a6fba063b2c165cf8adb19d6e3" id="r_a99e6d6a6fba063b2c165cf8adb19d6e3"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a99e6d6a6fba063b2c165cf8adb19d6e3">begin</a> () const</td></tr>
<tr class="memdesc:a99e6d6a6fba063b2c165cf8adb19d6e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning of the vector of remote characteristic pointers. <br /></td></tr>
<tr class="separator:a99e6d6a6fba063b2c165cf8adb19d6e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c00a195d20c8eba714979427f90c239" id="r_a4c00a195d20c8eba714979427f90c239"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_remote_service.html#a4c00a195d20c8eba714979427f90c239">end</a> () const</td></tr>
<tr class="memdesc:a4c00a195d20c8eba714979427f90c239"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end of the vector of remote characteristic pointers. <br /></td></tr>
<tr class="separator:a4c00a195d20c8eba714979427f90c239"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_nim_b_l_e_attribute"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_nim_b_l_e_attribute')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_nim_b_l_e_attribute.html">NimBLEAttribute</a></td></tr>
<tr class="memitem:afd4500e543c9480c52ca994ed5473e49 inherit pub_methods_class_nim_b_l_e_attribute" 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> &amp;&#160;</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 inherit pub_methods_class_nim_b_l_e_attribute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the UUID of the attribute. <br /></td></tr>
<tr class="separator:afd4500e543c9480c52ca994ed5473e49 inherit pub_methods_class_nim_b_l_e_attribute"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7907cb5b0a2d0f8cd9eb016a4ed876d1 inherit pub_methods_class_nim_b_l_e_attribute" id="r_a7907cb5b0a2d0f8cd9eb016a4ed876d1"><td class="memItemLeft" align="right" valign="top">
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>getHandle</b> () const</td></tr>
<tr class="memdesc:a7907cb5b0a2d0f8cd9eb016a4ed876d1 inherit pub_methods_class_nim_b_l_e_attribute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the handle of the attribute. <br /></td></tr>
<tr class="separator:a7907cb5b0a2d0f8cd9eb016a4ed876d1 inherit pub_methods_class_nim_b_l_e_attribute"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_nim_b_l_e_attribute"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_nim_b_l_e_attribute')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_nim_b_l_e_attribute.html">NimBLEAttribute</a></td></tr>
<tr class="memitem:a51ce8e9cd9609f42b9b9248a0b6c642c inherit pro_methods_class_nim_b_l_e_attribute" id="r_a51ce8e9cd9609f42b9b9248a0b6c642c"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;uuid, uint16_t handle)</td></tr>
<tr class="memdesc:a51ce8e9cd9609f42b9b9248a0b6c642c inherit pro_methods_class_nim_b_l_e_attribute"><td class="mdescLeft">&#160;</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 inherit pro_methods_class_nim_b_l_e_attribute"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a060f480742cfb09ed47c1f5421d00f inherit pro_methods_class_nim_b_l_e_attribute" id="r_a8a060f480742cfb09ed47c1f5421d00f"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>~NimBLEAttribute</b> ()=default</td></tr>
<tr class="memdesc:a8a060f480742cfb09ed47c1f5421d00f inherit pro_methods_class_nim_b_l_e_attribute"><td class="mdescLeft">&#160;</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 inherit pro_methods_class_nim_b_l_e_attribute"><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>A model of a remote BLE service. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a99e6d6a6fba063b2c165cf8adb19d6e3" name="a99e6d6a6fba063b2c165cf8adb19d6e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e6d6a6fba063b2c165cf8adb19d6e3">&#9670;&#160;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator NimBLERemoteService::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the beginning of the vector of remote characteristic pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the beginning of the vector of remote characteristic pointers. </dd></dl>
</div>
</div>
<a id="a828d57a4691d25e9e0e6124c3b0f1ac2" name="a828d57a4691d25e9e0e6124c3b0f1ac2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a828d57a4691d25e9e0e6124c3b0f1ac2">&#9670;&#160;</a></span>deleteCharacteristic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t NimBLERemoteService::deleteCharacteristic </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete characteristic by UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the characteristic to be removed from the local database. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of characteristics left. </dd></dl>
</div>
</div>
<a id="a7248e58b58753d8b44c420617d854408" name="a7248e58b58753d8b44c420617d854408"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7248e58b58753d8b44c420617d854408">&#9670;&#160;</a></span>deleteCharacteristics()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLERemoteService::deleteCharacteristics </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete the characteristics in the characteristics vector. </p>
<p>We maintain a vector called m_characteristicsVector that contains pointers to BLERemoteCharacteristic object references. Since we allocated these in this class, we are also responsible for deleting them. This method does just that. </p>
</div>
</div>
<a id="a4c00a195d20c8eba714979427f90c239" name="a4c00a195d20c8eba714979427f90c239"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c00a195d20c8eba714979427f90c239">&#9670;&#160;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt;::iterator NimBLERemoteService::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the end of the vector of remote characteristic pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the end of the vector of remote characteristic pointers. </dd></dl>
</div>
</div>
<a id="ae10ddb56bc48bd06538ab49e4a561594" name="ae10ddb56bc48bd06538ab49e4a561594"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae10ddb56bc48bd06538ab49e4a561594">&#9670;&#160;</a></span>getCharacteristic() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLERemoteService::getCharacteristic </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the remote characteristic object for the characteristic UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>Remote characteristic uuid. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the remote characteristic object. </dd></dl>
</div>
</div>
<a id="a404ee02ca3ecf8c9d244029ede066bda" name="a404ee02ca3ecf8c9d244029ede066bda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a404ee02ca3ecf8c9d244029ede066bda">&#9670;&#160;</a></span>getCharacteristic() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * NimBLERemoteService::getCharacteristic </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the characteristic object for the UUID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>Characteristic uuid. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the characteristic object, or nullptr if not found. </dd></dl>
</div>
</div>
<a id="a5b07f0756c401d40396886e80d64b03b" name="a5b07f0756c401d40396886e80d64b03b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b07f0756c401d40396886e80d64b03b">&#9670;&#160;</a></span>getCharacteristics()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; <a class="el" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> * &gt; &amp; NimBLERemoteService::getCharacteristics </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>refresh</em> = <code>false</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the vector of found characteristics. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">refresh</td><td>If true the current characteristics vector will cleared and all characteristics for this service retrieved from the peripheral. If false the vector will be returned with the currently stored characteristics of this service. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A read-only reference to the vector of characteristics retrieved for this service. </dd></dl>
</div>
</div>
<a id="a2f56031169ebeefcd834fff971a972c2" name="a2f56031169ebeefcd834fff971a972c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f56031169ebeefcd834fff971a972c2">&#9670;&#160;</a></span>getClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_client.html">NimBLEClient</a> * NimBLERemoteService::getClient </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the client associated with this service. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the client associated with this service. </dd></dl>
</div>
</div>
<a id="ac2f19f76f0c0ac9b0efe2baa2ad2f7ec" name="ac2f19f76f0c0ac9b0efe2baa2ad2f7ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2f19f76f0c0ac9b0efe2baa2ad2f7ec">&#9670;&#160;</a></span>getValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> NimBLERemoteService::getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read the value of a characteristic associated with this service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The characteristic to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string containing the value or an empty string if not found or error. </dd></dl>
</div>
</div>
<a id="a0d571db36b8af93b35d44f7cf4afa5ed" name="a0d571db36b8af93b35d44f7cf4afa5ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d571db36b8af93b35d44f7cf4afa5ed">&#9670;&#160;</a></span>setValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLERemoteService::setValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_att_value.html">NimBLEAttValue</a> &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of a characteristic. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The characteristic UUID to set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success, false if not found or error </dd></dl>
</div>
</div>
<a id="a347e848039121cbf3005349f9aa50680" name="a347e848039121cbf3005349f9aa50680"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a347e848039121cbf3005349f9aa50680">&#9670;&#160;</a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string NimBLERemoteService::toString </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string representation of this remote service. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of this remote service. </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_remote_service.html">NimBLERemoteService</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink