feedc0de/esp-nimble-cpp
1
0
Fork 0
forked from h2zero/esp-nimble-cpp
Code Pull Requests Activity

deploy: 4e80e1ee38

Browse Source
This commit is contained in:
h2zero
2025-01-13 02:22:00 +00:00
parent 8f225fee24
commit 8d94fd6f25
171 changed files with 1001 additions and 846 deletions
Download Patch File Download Diff File Expand all files Collapse all files
_nim_b_l_e_scan_8h_source.html
+10 -10
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>
@@ -217,11 +217,11 @@ $(document).ready(function(){initNavTree('_nim_b_l_e_scan_8h_source.html',''); i
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="preprocessor">#endif </span><span class="comment">// NIMBLE_CPP_SCAN_H_</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:41</div></div>
<div class="ttc" id="aclass_nim_b_l_e_advertised_device_html"><div class="ttname"><a href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a></div><div class="ttdoc">A representation of a BLE advertised device found by a scan.</div><div class="ttdef"><b>Definition</b> NimBLEAdvertisedDevice.h:45</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:109</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:116</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html">NimBLEScanCallbacks</a></div><div class="ttdoc">A callback handler for callbacks associated device scanning.</div><div class="ttdef"><b>Definition</b> NimBLEScan.h:115</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a1f9b5eac5982340afbb84954a4c06277"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a1f9b5eac5982340afbb84954a4c06277">NimBLEScanCallbacks::onDiscovered</a></div><div class="ttdeci">virtual void onDiscovered(const NimBLEAdvertisedDevice *advertisedDevice)</div><div class="ttdoc">Called when a new device is discovered, before the scan result is received (if applicable).</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:538</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a61c11db405e87ec847066ca3b6ad8375"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a61c11db405e87ec847066ca3b6ad8375">NimBLEScanCallbacks::onScanEnd</a></div><div class="ttdeci">virtual void onScanEnd(const NimBLEScanResults &amp;scanResults, int reason)</div><div class="ttdoc">Called when a scan operation ends.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:546</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a962d8b08cf14ac3091e6fd6962d7e283"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a962d8b08cf14ac3091e6fd6962d7e283">NimBLEScanCallbacks::onResult</a></div><div class="ttdeci">virtual void onResult(const NimBLEAdvertisedDevice *advertisedDevice)</div><div class="ttdoc">Called when a new scan result is complete, including scan response data (if applicable).</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:542</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a1f9b5eac5982340afbb84954a4c06277"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a1f9b5eac5982340afbb84954a4c06277">NimBLEScanCallbacks::onDiscovered</a></div><div class="ttdeci">virtual void onDiscovered(const NimBLEAdvertisedDevice *advertisedDevice)</div><div class="ttdoc">Called when a new device is discovered, before the scan result is received (if applicable).</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:545</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a61c11db405e87ec847066ca3b6ad8375"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a61c11db405e87ec847066ca3b6ad8375">NimBLEScanCallbacks::onScanEnd</a></div><div class="ttdeci">virtual void onScanEnd(const NimBLEScanResults &amp;scanResults, int reason)</div><div class="ttdoc">Called when a scan operation ends.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:553</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_callbacks_html_a962d8b08cf14ac3091e6fd6962d7e283"><div class="ttname"><a href="class_nim_b_l_e_scan_callbacks.html#a962d8b08cf14ac3091e6fd6962d7e283">NimBLEScanCallbacks::onResult</a></div><div class="ttdeci">virtual void onResult(const NimBLEAdvertisedDevice *advertisedDevice)</div><div class="ttdoc">Called when a new scan result is complete, including scan response data (if applicable).</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:549</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html"><div class="ttname"><a href="class_nim_b_l_e_scan.html">NimBLEScan</a></div><div class="ttdoc">Perform and manage BLE scans.</div><div class="ttdef"><b>Definition</b> NimBLEScan.h:67</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a0fec97ad0f4ff191bb853138c30d5316"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a0fec97ad0f4ff191bb853138c30d5316">NimBLEScan::setWindow</a></div><div class="ttdeci">void setWindow(uint16_t windowMs)</div><div class="ttdoc">Set the window to actively scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:257</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_a17f2f775b5e6793f06a412f840d5dceb"><div class="ttname"><a href="class_nim_b_l_e_scan.html#a17f2f775b5e6793f06a412f840d5dceb">NimBLEScan::setPhy</a></div><div class="ttdeci">void setPhy(Phy phyMask)</div><div class="ttdoc">Set the PHYs to scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:276</div></div>
@@ -240,11 +240,11 @@ $(document).ready(function(){initNavTree('_nim_b_l_e_scan_8h_source.html',''); i
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ac1307f30a881688d3a4d57bac7abe02c"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ac1307f30a881688d3a4d57bac7abe02c">NimBLEScan::start</a></div><div class="ttdeci">bool start(uint32_t duration, bool isContinue=false, bool restart=true)</div><div class="ttdoc">Start scanning.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:300</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_html_ad421a09eeb021755b193a7a5e01f183b"><div class="ttname"><a href="class_nim_b_l_e_scan.html#ad421a09eeb021755b193a7a5e01f183b">NimBLEScan::clearResults</a></div><div class="ttdeci">void clearResults()</div><div class="ttdoc">Clear the stored results of the scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:470</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></div><div class="ttdoc">A class that contains and operates on the results of a BLE scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.h:48</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a2547ebc0f9f0e1f48346ff0188ed6479"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a2547ebc0f9f0e1f48346ff0188ed6479">NimBLEScanResults::end</a></div><div class="ttdeci">std::vector&lt; NimBLEAdvertisedDevice * &gt;::const_iterator end() const</div><div class="ttdoc">Get iterator to the end of the vector of advertised device pointers.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:516</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a59c62c0825917ebb26bcb1efa2a98f4d"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a59c62c0825917ebb26bcb1efa2a98f4d">NimBLEScanResults::getCount</a></div><div class="ttdeci">int getCount() const</div><div class="ttdoc">Get the count of devices found in the last scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:490</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a5a0b1dc434c4ad68ae5ce233eeacc230"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a5a0b1dc434c4ad68ae5ce233eeacc230">NimBLEScanResults::begin</a></div><div class="ttdeci">std::vector&lt; NimBLEAdvertisedDevice * &gt;::const_iterator begin() const</div><div class="ttdoc">Get iterator to the beginning of the vector of advertised device pointers.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:508</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a98b106a3929919bf2c80cc0dfff59ba1"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a98b106a3929919bf2c80cc0dfff59ba1">NimBLEScanResults::getDevice</a></div><div class="ttdeci">const NimBLEAdvertisedDevice * getDevice(uint32_t idx) const</div><div class="ttdoc">Return the specified device at the given index. The index should be between 0 and getCount()-1.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:500</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_af143b1aa3bd67157dd263fcbeb4827ba"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#af143b1aa3bd67157dd263fcbeb4827ba">NimBLEScanResults::dump</a></div><div class="ttdeci">void dump() const</div><div class="ttdoc">Dump the scan results to the log.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:480</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a2547ebc0f9f0e1f48346ff0188ed6479"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a2547ebc0f9f0e1f48346ff0188ed6479">NimBLEScanResults::end</a></div><div class="ttdeci">std::vector&lt; NimBLEAdvertisedDevice * &gt;::const_iterator end() const</div><div class="ttdoc">Get iterator to the end of the vector of advertised device pointers.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:523</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a59c62c0825917ebb26bcb1efa2a98f4d"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a59c62c0825917ebb26bcb1efa2a98f4d">NimBLEScanResults::getCount</a></div><div class="ttdeci">int getCount() const</div><div class="ttdoc">Get the count of devices found in the last scan.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:497</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a5a0b1dc434c4ad68ae5ce233eeacc230"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a5a0b1dc434c4ad68ae5ce233eeacc230">NimBLEScanResults::begin</a></div><div class="ttdeci">std::vector&lt; NimBLEAdvertisedDevice * &gt;::const_iterator begin() const</div><div class="ttdoc">Get iterator to the beginning of the vector of advertised device pointers.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:515</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_a98b106a3929919bf2c80cc0dfff59ba1"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#a98b106a3929919bf2c80cc0dfff59ba1">NimBLEScanResults::getDevice</a></div><div class="ttdeci">const NimBLEAdvertisedDevice * getDevice(uint32_t idx) const</div><div class="ttdoc">Return the specified device at the given index. The index should be between 0 and getCount()-1.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:507</div></div>
<div class="ttc" id="aclass_nim_b_l_e_scan_results_html_af143b1aa3bd67157dd263fcbeb4827ba"><div class="ttname"><a href="class_nim_b_l_e_scan_results.html#af143b1aa3bd67157dd263fcbeb4827ba">NimBLEScanResults::dump</a></div><div class="ttdeci">void dump() const</div><div class="ttdoc">Dump the scan results to the log.</div><div class="ttdef"><b>Definition</b> NimBLEScan.cpp:485</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="astruct_nim_b_l_e_task_data_html"><div class="ttname"><a href="struct_nim_b_l_e_task_data.html">NimBLETaskData</a></div><div class="ttdoc">A structure to hold data for a task that is waiting for a response.</div><div class="ttdef"><b>Definition</b> NimBLEUtils.h:32</div></div>
</div><!-- fragment --></div><!-- contents -->