Matthew Lister / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Diff: public/ServiceDiscovery.h

Revision:
474:2a8a453ecd7e
Parent:
470:150c2363f776
Child:
476:122bcbdadb56
--- a/public/ServiceDiscovery.h	Fri Jun 19 15:51:59 2015 +0100
+++ b/public/ServiceDiscovery.h	Fri Jun 19 15:52:00 2015 +0100
@@ -36,9 +36,20 @@
                               const UUID               &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
                               const UUID               &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN));
 
+    /**
+     * Terminate an ongoing service-discovery. This should result in an
+     * invocation of the TerminationCallback if service-discovery is active.
+     */
     static void        terminate(void);
 
+    /**
+     * Is service-discovery currently active?
+     */
     static bool        isActive(void);
+
+    /**
+     * Setup callback to be invoked when service discovery is terminated.
+     */
     static void        onTermination(TerminationCallback_t callback);
 
 protected: