Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

Embed: (wiki syntax)

« Back to documentation index

GattService Class Reference
Public Types | Public Member Functions

GattService Class Reference
[Server]

Representation of a GattServer service. More...

#include <GattService.h>

Public Types

enum  {
  UUID_ALERT_NOTIFICATION_SERVICE = 0x1811, UUID_BATTERY_SERVICE = 0x180F, UUID_BLOOD_PRESSURE_SERVICE = 0x1810, UUID_CURRENT_TIME_SERVICE = 0x1805,
  UUID_CYCLING_SPEED_AND_CADENCE = 0x1816, UUID_DEVICE_INFORMATION_SERVICE = 0x180A, UUID_ENVIRONMENTAL_SERVICE = 0x181A, UUID_GLUCOSE_SERVICE = 0x1808,
  UUID_HEALTH_THERMOMETER_SERVICE = 0x1809, UUID_HEART_RATE_SERVICE = 0x180D, UUID_HUMAN_INTERFACE_DEVICE_SERVICE = 0x1812, UUID_IMMEDIATE_ALERT_SERVICE = 0x1802,
  UUID_LINK_LOSS_SERVICE = 0x1803, UUID_NEXT_DST_CHANGE_SERVICE = 0x1807, UUID_PHONE_ALERT_STATUS_SERVICE = 0x180E, UUID_REFERENCE_TIME_UPDATE_SERVICE = 0x1806,
  UUID_RUNNING_SPEED_AND_CADENCE = 0x1814, UUID_SCAN_PARAMETERS_SERVICE = 0x1813, UUID_TX_POWER_SERVICE = 0x1804
}

Public Member Functions

 GattService (const UUID &uuid, GattCharacteristic *characteristics[], unsigned numCharacteristics)
 Construct a GattService.
const UUID & getUUID (void) const
 Get this service's UUID.
uint16_t getHandle (void) const
 Get the handle of the service declaration attribute in the ATT table.
uint8_t getCharacteristicCount (void) const
 Get the total number of characteristics within this service.
void setHandle (uint16_t handle)
 Set the handle of the service declaration attribute in the ATT table.
GattCharacteristic * getCharacteristic (uint8_t index)
 Get this service's characteristic at a specific index.

Detailed Description

Representation of a GattServer service.

A service is a cohesive collection of characteristics. It is identified by a UUID and starts at a specific handle of its GattServer.

Definition at line 38 of file GattService.h.

Member Enumeration Documentation

anonymous enum
Enumerator:
UUID_ALERT_NOTIFICATION_SERVICE 

UUID of the Alert Notification service.

UUID_BATTERY_SERVICE 

UUID of the Battery service.

UUID_BLOOD_PRESSURE_SERVICE 

UUID of the Blood Pressure service.

UUID_CURRENT_TIME_SERVICE 

UUID of the Current Time service.

UUID_CYCLING_SPEED_AND_CADENCE 

UUID of the Cycling Speed and Cadence (CSC) service.

UUID_DEVICE_INFORMATION_SERVICE 

UUID of the Device Information Service (DIS).

UUID_ENVIRONMENTAL_SERVICE 

UUID of the environmental service.

UUID_GLUCOSE_SERVICE 

UUID of the Glucose service.

UUID_HEALTH_THERMOMETER_SERVICE 

UUID of the health thermometer.

UUID_HEART_RATE_SERVICE 

UUID of the Heart Rate service.

UUID_HUMAN_INTERFACE_DEVICE_SERVICE 

UUID of the Human Interface Device (HID) service.

UUID_IMMEDIATE_ALERT_SERVICE 

UUID of the Immediate Alert service.

UUID_LINK_LOSS_SERVICE 

UUID of the Link Loss service.

UUID_NEXT_DST_CHANGE_SERVICE 

UUID of the Next DST change service.

UUID_PHONE_ALERT_STATUS_SERVICE 

UUID of the Phone Alert Status service.

UUID_REFERENCE_TIME_UPDATE_SERVICE 

UUID of the Reference Time Update service.

UUID_RUNNING_SPEED_AND_CADENCE 

UUID of the Running Speed and Cadence (RSC) service.

UUID_SCAN_PARAMETERS_SERVICE 

UUID of the Scan Parameter service.

UUID_TX_POWER_SERVICE 

UUID of the TX power service.

Definition at line 40 of file GattService.h.

Constructor & Destructor Documentation

GattService ( const UUID &  uuid,
GattCharacteristic *  characteristics[],
unsigned  numCharacteristics 
)

Construct a GattService.

Parameters:
[in]uuidThe UUID assigned to this service.
[in]characteristicsA pointer to the array of characteristics that belongs to the service.
[in]numCharacteristicsThe number of characteristics.

The characteristics of the service must remain valid while the GattServer uses the service.

Definition at line 149 of file GattService.h.

Member Function Documentation

GattCharacteristic* getCharacteristic ( uint8_t  index )

Get this service's characteristic at a specific index.

Parameters:
[in]indexThe index of the characteristic.
Returns:
A pointer to the characteristic at index index.

Definition at line 209 of file GattService.h.

uint8_t getCharacteristicCount ( void   ) const

Get the total number of characteristics within this service.

Returns:
The total number of characteristics within this service.

Definition at line 185 of file GattService.h.

uint16_t getHandle ( void   ) const

Get the handle of the service declaration attribute in the ATT table.

Returns:
The service's handle.

Definition at line 175 of file GattService.h.

const UUID& getUUID ( void   ) const

Get this service's UUID.

Returns:
A reference to the service's UUID.

Definition at line 165 of file GattService.h.

void setHandle ( uint16_t  handle )

Set the handle of the service declaration attribute in the ATT table.

Application code must not use this API.

Parameters:
[in]handleThe service's handle.

Definition at line 197 of file GattService.h.

Generated on Sun Jul 17 2022 08:25:40 by  doxygen 1.7.2