xiao sun / 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.

Fork of BLE_API by Bluetooth Low Energy

hw/GattServerEvents.h@34:da2ea8cd6216, 2014-05-21 (annotated)

Committer:
Rohit Grover
Date:
Wed May 21 15:01:14 2014 +0100
Revision:
34:da2ea8cd6216
Parent:
31:2c94f0501807
Child:
77:1436ecf09583
white space diffs; generated using uncrustify

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 31:2c94f0501807 1 /* mbed Microcontroller Library
bogdanm 31:2c94f0501807 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 31:2c94f0501807 3 *
bogdanm 31:2c94f0501807 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 31:2c94f0501807 5 * you may not use this file except in compliance with the License.
bogdanm 31:2c94f0501807 6 * You may obtain a copy of the License at
bogdanm 31:2c94f0501807 7 *
bogdanm 31:2c94f0501807 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 31:2c94f0501807 9 *
bogdanm 31:2c94f0501807 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 31:2c94f0501807 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 31:2c94f0501807 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 31:2c94f0501807 13 * See the License for the specific language governing permissions and
bogdanm 31:2c94f0501807 14 * limitations under the License.
Rohit Grover 34:da2ea8cd6216 15 */
bogdanm 31:2c94f0501807 16
bogdanm 31:2c94f0501807 17 #ifndef __GATT_SERVER_EVENTS_H__
bogdanm 31:2c94f0501807 18 #define __GATT_SERVER_EVENTS_H__
bogdanm 31:2c94f0501807 19
bogdanm 31:2c94f0501807 20 #include "blecommon.h"
bogdanm 31:2c94f0501807 21 #include "mbed.h"
bogdanm 31:2c94f0501807 22
bogdanm 31:2c94f0501807 23 /**************************************************************************/
bogdanm 31:2c94f0501807 24 /*!
bogdanm 31:2c94f0501807 25 \brief
bogdanm 31:2c94f0501807 26 The base class used to abstract away the callback events that can be
bogdanm 31:2c94f0501807 27 triggered with the GATT Server.
bogdanm 31:2c94f0501807 28 */
bogdanm 31:2c94f0501807 29 /**************************************************************************/
bogdanm 31:2c94f0501807 30 class GattServerEvents {
Rohit Grover 34:da2ea8cd6216 31 public:
Rohit Grover 34:da2ea8cd6216 32 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 33 /*!
Rohit Grover 34:da2ea8cd6216 34 \brief
Rohit Grover 34:da2ea8cd6216 35 Identifies GATT events generated by the radio HW when an event
Rohit Grover 34:da2ea8cd6216 36 callback occurs
Rohit Grover 34:da2ea8cd6216 37 */
Rohit Grover 34:da2ea8cd6216 38 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 39 typedef enum gattEvent_e
Rohit Grover 34:da2ea8cd6216 40 {
Rohit Grover 34:da2ea8cd6216 41 GATT_EVENT_DATA_SENT = 1, /**< Fired when a msg was
Rohit Grover 34:da2ea8cd6216 42 *successfully sent out
Rohit Grover 34:da2ea8cd6216 43 *(notify only?) */
Rohit Grover 34:da2ea8cd6216 44 GATT_EVENT_DATA_WRITTEN = 2, /**< Client wrote data to
Rohit Grover 34:da2ea8cd6216 45 *Server (separate into
Rohit Grover 34:da2ea8cd6216 46 *char and descriptor
Rohit Grover 34:da2ea8cd6216 47 *writes?) */
Rohit Grover 34:da2ea8cd6216 48 GATT_EVENT_UPDATES_ENABLED = 3, /**< Notify/Indicate
Rohit Grover 34:da2ea8cd6216 49 *Enabled in CCCD */
Rohit Grover 34:da2ea8cd6216 50 GATT_EVENT_UPDATES_DISABLED = 4, /**< Notify/Indicate
Rohit Grover 34:da2ea8cd6216 51 *Disabled in CCCD */
Rohit Grover 34:da2ea8cd6216 52 GATT_EVENT_CONFIRMATION_RECEIVED = 5 /**< Response received
Rohit Grover 34:da2ea8cd6216 53 *from Indicate message */
Rohit Grover 34:da2ea8cd6216 54 } gattEvent_t;
bogdanm 31:2c94f0501807 55
Rohit Grover 34:da2ea8cd6216 56 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 57 /*!
Rohit Grover 34:da2ea8cd6216 58 \brief
Rohit Grover 34:da2ea8cd6216 59 A message was successfully transmitted
Rohit Grover 34:da2ea8cd6216 60 */
Rohit Grover 34:da2ea8cd6216 61 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 62 virtual void onDataSent(uint16_t charHandle) {
Rohit Grover 34:da2ea8cd6216 63 }
bogdanm 31:2c94f0501807 64
Rohit Grover 34:da2ea8cd6216 65 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 66 /*!
Rohit Grover 34:da2ea8cd6216 67 \brief
Rohit Grover 34:da2ea8cd6216 68 The GATT client (the phone, tablet, etc.) wrote data to a
Rohit Grover 34:da2ea8cd6216 69 characteristic or descriptor on the GATT Server (the peripheral
Rohit Grover 34:da2ea8cd6216 70 device).
Rohit Grover 34:da2ea8cd6216 71 */
Rohit Grover 34:da2ea8cd6216 72 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 73 virtual void onDataWritten(uint16_t charHandle) {
Rohit Grover 34:da2ea8cd6216 74 }
bogdanm 31:2c94f0501807 75
Rohit Grover 34:da2ea8cd6216 76 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 77 /*!
Rohit Grover 34:da2ea8cd6216 78 \brief
Rohit Grover 34:da2ea8cd6216 79 A Notify or Indicate flag was enabled in the CCCD
Rohit Grover 34:da2ea8cd6216 80 */
Rohit Grover 34:da2ea8cd6216 81 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 82 virtual void onUpdatesEnabled(uint16_t charHandle) {
Rohit Grover 34:da2ea8cd6216 83 }
bogdanm 31:2c94f0501807 84
Rohit Grover 34:da2ea8cd6216 85 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 86 /*!
Rohit Grover 34:da2ea8cd6216 87 \brief
Rohit Grover 34:da2ea8cd6216 88 A Notify or Indicate flag was disabled in the CCCD
Rohit Grover 34:da2ea8cd6216 89 */
Rohit Grover 34:da2ea8cd6216 90 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 91 virtual void onUpdatesDisabled(uint16_t charHandle) {
Rohit Grover 34:da2ea8cd6216 92 }
bogdanm 31:2c94f0501807 93
Rohit Grover 34:da2ea8cd6216 94 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 95 /*!
Rohit Grover 34:da2ea8cd6216 96 \brief
Rohit Grover 34:da2ea8cd6216 97 A confirmation response was received from an Indicate message
Rohit Grover 34:da2ea8cd6216 98 */
Rohit Grover 34:da2ea8cd6216 99 /******************************************************************/
Rohit Grover 34:da2ea8cd6216 100 virtual void onConfirmationReceived(uint16_t charHandle) {
Rohit Grover 34:da2ea8cd6216 101 }
bogdanm 31:2c94f0501807 102 };
bogdanm 31:2c94f0501807 103
Rohit Grover 34:da2ea8cd6216 104 #endif // ifndef __GATT_SERVER_EVENTS_H__