ServiceDiscovery Class Reference
[Client]

Characteristic discovered event handler.

The callback accepts a pointer to a DiscoveredCharacteristic as parameter.

The argument passed to the callback may not persist after the callback invocation; therefore, the callbacks must make a shallow copy of the DiscoveredCharacteristic passed as parameter to access its value beyond the callback scope.

Definition at line 72 of file ServiceDiscovery.h.

Service discovered event handler.

The callback accepts a pointer to a DiscoveredService as parameter.

The argument passed to the callback may not persist after the callback invocation; therefore, the callbacks must make a shallow copy of the DiscoveredService passed as parameter to access its value beyond the callback scope.

Definition at line 58 of file ServiceDiscovery.h.

Service discovery ended event.

The callback accepts a connection handle as parameter. This parameter is used to identify on which connection the service discovery process ended.

Definition at line 81 of file ServiceDiscovery.h.

Check whether service-discovery is currently active.

Launch service discovery.

Once launched, service discovery remains active with callbacks being issued back into the application for matching services or characteristics. isActive() can be used to determine status, and a termination callback (if set up) is invoked at the end. Service discovery can be terminated prematurely, if needed, using terminate().

Parameters:

connectionHandle	Handle for the connection with the peer.
sc	This is the application callback for a matching service. Taken as NULL by default. Note: service discovery may still be active when this callback is issued; calling asynchronous BLE-stack APIs from within this application callback might cause the stack to abort service discovery. If this becomes an issue, it may be better to make a local copy of the discoveredService and wait for service discovery to terminate before operating on the service.
cc	This is the application callback for a matching characteristic. Taken as NULL by default. Note: service discovery may still be active when this callback is issued; calling asynchronous BLE-stack APIs from within this application callback might cause the stack to abort service discovery. If this becomes an issue, it may be better to make a local copy of the discoveredCharacteristic and wait for service discovery to terminate before operating on the characteristic.
matchingServiceUUID	UUID-based filter for specifying a service in which the application is interested. By default, it is set as the wildcard UUID_UNKNOWN, in which case it matches all services. If characteristic-UUID filter (below) is set to the wildcard value, then a service callback is invoked for the matching service (or for every service if the service filter is a wildcard).
matchingCharacteristicUUIDIn	UUID-based filter for specifying a characteristic in which the application is interested. By default, it is set as the wildcard UUID_UKNOWN to match against any characteristic. If both service-UUID filter and characteristic-UUID filter are used with nonwildcard values, then only a single characteristic callback is invoked for the matching characteristic.

Note:

Using wildcard values for both service-UUID and characteristic- UUID result in complete service discovery: callbacks being called for every service and characteristic.

Providing NULL for the characteristic callback results in characteristic discovery being skipped for each matching service. This allows for an inexpensive method to discover only services.

Returns:

BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error.

Set up a callback to be invoked when service discovery is terminated.

Clear all ServiceDiscovery state of the associated object.

This function is meant to be overridden in the platform-specific subclass. Nevertheless, the subclass is only expected to reset its state and not the data held in ServiceDiscovery members. This is achieved by a call to ServiceDiscovery::reset() from the subclass' reset() implementation.

Returns:

BLE_ERROR_NONE on success.

Definition at line 171 of file ServiceDiscovery.h.

Terminate an ongoing service discovery.

This should result in an invocation of the TerminationCallback if service discovery is active.

The registered callback handler for when a matching characteristic is found during service-discovery.

Definition at line 205 of file ServiceDiscovery.h.

Connection handle as provided by the SoftDevice.

Definition at line 185 of file ServiceDiscovery.h.

UUID-based filter that specifies the characteristic that the application is interested in.

Definition at line 200 of file ServiceDiscovery.h.

UUID-based filter that specifies the service that the application is interested in.

Definition at line 190 of file ServiceDiscovery.h.

The registered callback handle for when a matching service is found during service-discovery.

Definition at line 195 of file ServiceDiscovery.h.