This commit is contained in:
h2zero committed 2025-01-13 02:22:00 +00:00
1 parent 8f225fee24
commit 8d94fd6f25
171 files changed
+1001 -846

No files matched your search

+19 -19
View File
@@ -25,7 +25,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.3</span>
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.1.0</span>
</div>
</td>
</tr>
@@ -179,24 +179,24 @@ $(document).ready(function(){initNavTree('_nim_b_l_e_remote_characteristic_8h_so
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="preprocessor">#endif </span><span class="comment">/* NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition</b> NimBLEClient.h:49</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></div><div class="ttdoc">A model of a remote BLE characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.h:34</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a03c4da5f5fc36bd5f66c39aed3feb6f2"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a03c4da5f5fc36bd5f66c39aed3feb6f2">NimBLERemoteCharacteristic::deleteDescriptor</a></div><div class="ttdeci">size_t deleteDescriptor(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Delete descriptor by UUID.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:293</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0920d576b12ee1e20a724a7da836d153"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0920d576b12ee1e20a724a7da836d153">NimBLERemoteCharacteristic::canWriteNoResponse</a></div><div class="ttdeci">bool canWriteNoResponse() const</div><div class="ttdoc">Does the characteristic support writing without a response?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:328</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0d8e8ae12a89d64d0ca52dd3b3b7c67d"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0d8e8ae12a89d64d0ca52dd3b3b7c67d">NimBLERemoteCharacteristic::canBroadcast</a></div><div class="ttdeci">bool canBroadcast() const</div><div class="ttdoc">Does the characteristic support value broadcasting?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:312</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a160cf1b93ae583038606d27b258156e9"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a160cf1b93ae583038606d27b258156e9">NimBLERemoteCharacteristic::begin</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator begin() const</div><div class="ttdoc">Get iterator to the beginning of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:208</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a17aea026b6a795dbb6bcdc27bbe3d17e"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a17aea026b6a795dbb6bcdc27bbe3d17e">NimBLERemoteCharacteristic::end</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator end() const</div><div class="ttdoc">Get iterator to the end of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:216</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a1b021f9ca0501abed573daee878b51eb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a1b021f9ca0501abed573daee878b51eb">NimBLERemoteCharacteristic::deleteDescriptors</a></div><div class="ttdeci">void deleteDescriptors() const</div><div class="ttdoc">Delete the descriptors in the descriptor vector.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:277</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a1b3bbd1bcdde6dd952ee69ebad0ffc58"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a1b3bbd1bcdde6dd952ee69ebad0ffc58">NimBLERemoteCharacteristic::getRemoteService</a></div><div class="ttdeci">const NimBLERemoteService * getRemoteService() const</div><div class="ttdoc">Get the remote service associated with this characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:224</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a27746c8b2405beb1d44567e2c1f85f87"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a27746c8b2405beb1d44567e2c1f85f87">NimBLERemoteCharacteristic::getDescriptors</a></div><div class="ttdeci">const std::vector&lt; NimBLERemoteDescriptor * &gt; &amp; getDescriptors(bool refresh=false) const</div><div class="ttdoc">Get a pointer to the vector of found descriptors.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:195</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a3ba2263c976bd4ece81a6b37e09fa121"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a3ba2263c976bd4ece81a6b37e09fa121">NimBLERemoteCharacteristic::canWrite</a></div><div class="ttdeci">bool canWrite() const</div><div class="ttdoc">Does the characteristic support writing?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:336</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a4be19e1a3a82f3db0fa8a7236638b737"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a4be19e1a3a82f3db0fa8a7236638b737">NimBLERemoteCharacteristic::canRead</a></div><div class="ttdeci">bool canRead() const</div><div class="ttdoc">Does the characteristic support reading?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:320</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a64a74ffc6612cf4a42f33836e34887f0"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a64a74ffc6612cf4a42f33836e34887f0">NimBLERemoteCharacteristic::unsubscribe</a></div><div class="ttdeci">bool unsubscribe(bool response=true) const</div><div class="ttdoc">Unsubscribe for notifications or indications.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:267</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a79dbe281933d8cab342a5506746b9ded"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a79dbe281933d8cab342a5506746b9ded">NimBLERemoteCharacteristic::canIndicate</a></div><div class="ttdeci">bool canIndicate() const</div><div class="ttdoc">Does the characteristic support indication?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:352</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a8a2e29de02b97c99e88ce1a56e54cdd7"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a8a2e29de02b97c99e88ce1a56e54cdd7">NimBLERemoteCharacteristic::getDescriptor</a></div><div class="ttdeci">NimBLERemoteDescriptor * getDescriptor(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Get the descriptor instance with the given UUID that belongs to this characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:138</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ad77a00c64a83dd58e985e3bbefd87ce2"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ad77a00c64a83dd58e985e3bbefd87ce2">NimBLERemoteCharacteristic::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Convert a NimBLERemoteCharacteristic to a string representation;.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:376</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_adf445e6bd9dee047a61c708ae943304a"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#adf445e6bd9dee047a61c708ae943304a">NimBLERemoteCharacteristic::subscribe</a></div><div class="ttdeci">bool subscribe(bool notifications=true, const notify_callback notifyCallback=nullptr, bool response=true) const</div><div class="ttdoc">Subscribe for notifications or indications.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:258</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ae3b10383d5b72bdf241bb2f215836772"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ae3b10383d5b72bdf241bb2f215836772">NimBLERemoteCharacteristic::canNotify</a></div><div class="ttdeci">bool canNotify() const</div><div class="ttdoc">Does the characteristic support reading with encryption?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:344</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_afb07f80d83e41768d228b92210b83657"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#afb07f80d83e41768d228b92210b83657">NimBLERemoteCharacteristic::canWriteSigned</a></div><div class="ttdeci">bool canWriteSigned() const</div><div class="ttdoc">Does the characteristic support signed writing?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:360</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aff5a242abcba3f239bd177cebc69e1cb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aff5a242abcba3f239bd177cebc69e1cb">NimBLERemoteCharacteristic::hasExtendedProps</a></div><div class="ttdeci">bool hasExtendedProps() const</div><div class="ttdoc">Does the characteristic support extended properties?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:368</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a03c4da5f5fc36bd5f66c39aed3feb6f2"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a03c4da5f5fc36bd5f66c39aed3feb6f2">NimBLERemoteCharacteristic::deleteDescriptor</a></div><div class="ttdeci">size_t deleteDescriptor(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Delete descriptor by UUID.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:288</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0920d576b12ee1e20a724a7da836d153"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0920d576b12ee1e20a724a7da836d153">NimBLERemoteCharacteristic::canWriteNoResponse</a></div><div class="ttdeci">bool canWriteNoResponse() const</div><div class="ttdoc">Does the characteristic support writing without a response?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:323</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0d8e8ae12a89d64d0ca52dd3b3b7c67d"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0d8e8ae12a89d64d0ca52dd3b3b7c67d">NimBLERemoteCharacteristic::canBroadcast</a></div><div class="ttdeci">bool canBroadcast() const</div><div class="ttdoc">Does the characteristic support value broadcasting?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:307</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a160cf1b93ae583038606d27b258156e9"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a160cf1b93ae583038606d27b258156e9">NimBLERemoteCharacteristic::begin</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator begin() const</div><div class="ttdoc">Get iterator to the beginning of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:203</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a17aea026b6a795dbb6bcdc27bbe3d17e"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a17aea026b6a795dbb6bcdc27bbe3d17e">NimBLERemoteCharacteristic::end</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator end() const</div><div class="ttdoc">Get iterator to the end of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:211</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a1b021f9ca0501abed573daee878b51eb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a1b021f9ca0501abed573daee878b51eb">NimBLERemoteCharacteristic::deleteDescriptors</a></div><div class="ttdeci">void deleteDescriptors() const</div><div class="ttdoc">Delete the descriptors in the descriptor vector.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:272</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a1b3bbd1bcdde6dd952ee69ebad0ffc58"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a1b3bbd1bcdde6dd952ee69ebad0ffc58">NimBLERemoteCharacteristic::getRemoteService</a></div><div class="ttdeci">const NimBLERemoteService * getRemoteService() const</div><div class="ttdoc">Get the remote service associated with this characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:219</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a27746c8b2405beb1d44567e2c1f85f87"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a27746c8b2405beb1d44567e2c1f85f87">NimBLERemoteCharacteristic::getDescriptors</a></div><div class="ttdeci">const std::vector&lt; NimBLERemoteDescriptor * &gt; &amp; getDescriptors(bool refresh=false) const</div><div class="ttdoc">Get a pointer to the vector of found descriptors.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:190</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a3ba2263c976bd4ece81a6b37e09fa121"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a3ba2263c976bd4ece81a6b37e09fa121">NimBLERemoteCharacteristic::canWrite</a></div><div class="ttdeci">bool canWrite() const</div><div class="ttdoc">Does the characteristic support writing?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:331</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a4be19e1a3a82f3db0fa8a7236638b737"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a4be19e1a3a82f3db0fa8a7236638b737">NimBLERemoteCharacteristic::canRead</a></div><div class="ttdeci">bool canRead() const</div><div class="ttdoc">Does the characteristic support reading?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:315</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a64a74ffc6612cf4a42f33836e34887f0"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a64a74ffc6612cf4a42f33836e34887f0">NimBLERemoteCharacteristic::unsubscribe</a></div><div class="ttdeci">bool unsubscribe(bool response=true) const</div><div class="ttdoc">Unsubscribe for notifications or indications.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:262</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a79dbe281933d8cab342a5506746b9ded"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a79dbe281933d8cab342a5506746b9ded">NimBLERemoteCharacteristic::canIndicate</a></div><div class="ttdeci">bool canIndicate() const</div><div class="ttdoc">Does the characteristic support indication?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:347</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a8a2e29de02b97c99e88ce1a56e54cdd7"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a8a2e29de02b97c99e88ce1a56e54cdd7">NimBLERemoteCharacteristic::getDescriptor</a></div><div class="ttdeci">NimBLERemoteDescriptor * getDescriptor(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Get the descriptor instance with the given UUID that belongs to this characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:133</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ad77a00c64a83dd58e985e3bbefd87ce2"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ad77a00c64a83dd58e985e3bbefd87ce2">NimBLERemoteCharacteristic::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Convert a NimBLERemoteCharacteristic to a string representation;.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:371</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_adf445e6bd9dee047a61c708ae943304a"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#adf445e6bd9dee047a61c708ae943304a">NimBLERemoteCharacteristic::subscribe</a></div><div class="ttdeci">bool subscribe(bool notifications=true, const notify_callback notifyCallback=nullptr, bool response=true) const</div><div class="ttdoc">Subscribe for notifications or indications.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:253</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ae3b10383d5b72bdf241bb2f215836772"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ae3b10383d5b72bdf241bb2f215836772">NimBLERemoteCharacteristic::canNotify</a></div><div class="ttdeci">bool canNotify() const</div><div class="ttdoc">Does the characteristic support reading with encryption?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:339</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_afb07f80d83e41768d228b92210b83657"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#afb07f80d83e41768d228b92210b83657">NimBLERemoteCharacteristic::canWriteSigned</a></div><div class="ttdeci">bool canWriteSigned() const</div><div class="ttdoc">Does the characteristic support signed writing?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:355</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aff5a242abcba3f239bd177cebc69e1cb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aff5a242abcba3f239bd177cebc69e1cb">NimBLERemoteCharacteristic::hasExtendedProps</a></div><div class="ttdeci">bool hasExtendedProps() const</div><div class="ttdoc">Does the characteristic support extended properties?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:363</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></div><div class="ttdoc">A model of remote BLE descriptor.</div><div class="ttdef"><b>Definition</b> NimBLERemoteDescriptor.h:32</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></div><div class="ttdoc">A model of a remote BLE service.</div><div class="ttdef"><b>Definition</b> NimBLERemoteService.h:34</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>