BA / Mbed OS BaBoRo1

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.

Embed: (wiki syntax)

« Back to documentation index

DiscoveredService Class Reference
Public Member Functions

DiscoveredService Class Reference
[Client]

Representation of a GATT service discovered. More...

#include <DiscoveredService.h>

Public Member Functions

const UUID & getUUID (void) const
 Get the UUID of the discovered service.
const GattAttribute::Handle_t & getStartHandle (void) const
 Get the start handle of the discovered service in the peer's GATT server.
const GattAttribute::Handle_t & getEndHandle (void) const
 Get the end handle of the discovered service in the peer's GATT server.
 DiscoveredService ()
 Construct a DiscoveredService instance.
void setup (UUID uuidIn, GattAttribute::Handle_t startHandleIn, GattAttribute::Handle_t endHandleIn)
 Set information about the discovered service.
void setup (GattAttribute::Handle_t startHandleIn, GattAttribute::Handle_t endHandleIn)
 Set the start and end handle of the discovered service.
void setupLongUUID (UUID::LongUUIDBytes_t longUUID, UUID::ByteOrder_t order=UUID::MSB)
 Set the long UUID of the discovered service.

Detailed Description

Representation of a GATT service discovered.

The discovery procedure discovers GATT Services are discovered on distant GATT servers, which can be initiated by calling GattClient::launchServiceDiscovery() or GattClient::discoverServices(). The discovery process passes instances of this class to the callback handling service discovered.

Discovered services are characterized by the UUID of the service discovered and the range of the GATT attributes belonging to the service.

The UUID can be queried by calling getUUID() while the begining of the attribute range can be obtained through getStartHandle() and the end of the attribute range with a call to getEndHandle().

The characteristics composing the service may be discovered by the function GattClient::launchServiceDiscovery().

Definition at line 51 of file DiscoveredService.h.

Constructor & Destructor Documentation

DiscoveredService (  )

Construct a DiscoveredService instance.

Attention:
This API is not meant to be used publicly. It is meant to be used by internal APIs of Mbed BLE.

Definition at line 90 of file DiscoveredService.h.

Member Function Documentation

const GattAttribute::Handle_t& getEndHandle ( void   ) const

Get the end handle of the discovered service in the peer's GATT server.

Returns:
A reference to the end handle.

Definition at line 78 of file DiscoveredService.h.

const GattAttribute::Handle_t& getStartHandle ( void   ) const

Get the start handle of the discovered service in the peer's GATT server.

Returns:
A reference to the start handle.

Definition at line 68 of file DiscoveredService.h.

const UUID& getUUID ( void   ) const

Get the UUID of the discovered service.

Returns:
A reference to the UUID of the discovered service.

Definition at line 58 of file DiscoveredService.h.

void setup ( UUID  uuidIn,
GattAttribute::Handle_t  startHandleIn,
GattAttribute::Handle_t  endHandleIn 
)

Set information about the discovered service.

Attention:
This API is not meant to be used publicly. It is meant to be used by internal APIs of Mbed BLE.
Parameters:
[in]uuidInThe UUID of the discovered service.
[in]startHandleInThe start handle of the discovered service in the peer's GATT server.
[in]endHandleInThe end handle of the discovered service in the peer's GATT server.

Definition at line 108 of file DiscoveredService.h.

void setup ( GattAttribute::Handle_t  startHandleIn,
GattAttribute::Handle_t  endHandleIn 
)

Set the start and end handle of the discovered service.

Attention:
This API is not meant to be used publicly. It is meant to be used by internal APIs of Mbed BLE.
Parameters:
[in]startHandleInThe start handle of the discovered service in the peer's GATT server.
[in]endHandleInThe end handle of the discovered service in the peer's GATT server.

Definition at line 129 of file DiscoveredService.h.

void setupLongUUID ( UUID::LongUUIDBytes_t  longUUID,
UUID::ByteOrder_t  order = UUID::MSB 
)

Set the long UUID of the discovered service.

Attention:
This API is not meant to be used publicly. It is meant to be used by internal APIs of Mbed BLE.
Parameters:
[in]longUUIDThe bytes composing the long UUID of this discovered service.
[in]orderThe byte ordering of longUUID.

Definition at line 147 of file DiscoveredService.h.

Generated on Tue Jul 12 2022 12:22:43 by  doxygen 1.7.2