Austin Blackstone / BLE_API

Fixes to BLE_API for mbedOS Alpha1 release. Mostly relating to doxygen fixes.

Fork of BLE_API by Bluetooth Low Energy

public/GattServer.h@140:407d134c179d, 2014-11-21 (annotated)

Committer:
rgrover1
Date:
Fri Nov 21 09:23:24 2014 +0000
Revision:
140:407d134c179d
Parent:
139:baaf1c5f0db2
Child:
143:8bdf577b1598
Synchronized with git rev 5b8a2fb5

Author: Rohit Grover

making APIs within GattServer private; but adding friend BLEDevice.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 106:a20be740075d 1 /* mbed Microcontroller Library
Rohit Grover 106:a20be740075d 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 106:a20be740075d 3 *
Rohit Grover 106:a20be740075d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 106:a20be740075d 5 * you may not use this file except in compliance with the License.
Rohit Grover 106:a20be740075d 6 * You may obtain a copy of the License at
Rohit Grover 106:a20be740075d 7 *
Rohit Grover 106:a20be740075d 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 106:a20be740075d 9 *
Rohit Grover 106:a20be740075d 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 106:a20be740075d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 106:a20be740075d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 106:a20be740075d 13 * See the License for the specific language governing permissions and
Rohit Grover 106:a20be740075d 14 * limitations under the License.
Rohit Grover 106:a20be740075d 15 */
Rohit Grover 106:a20be740075d 16
Rohit Grover 106:a20be740075d 17 #ifndef __GATT_SERVER_H__
Rohit Grover 106:a20be740075d 18 #define __GATT_SERVER_H__
Rohit Grover 106:a20be740075d 19
Rohit Grover 106:a20be740075d 20 #include "GattService.h"
Rohit Grover 106:a20be740075d 21 #include "GattServerEvents.h"
Rohit Grover 116:ca826083980e 22 #include "GattCharacteristicWriteCBParams.h"
Rohit Grover 118:620d28e7a1ba 23 #include "CallChainOfFunctionPointersWithContext.h"
Rohit Grover 106:a20be740075d 24
Rohit Grover 106:a20be740075d 25 /**************************************************************************/
Rohit Grover 106:a20be740075d 26 /*!
Rohit Grover 106:a20be740075d 27 \brief
Rohit Grover 106:a20be740075d 28 The base class used to abstract GATT Server functionality to a specific
Rohit Grover 106:a20be740075d 29 radio transceiver, SOC or BLE Stack.
Rohit Grover 106:a20be740075d 30 */
Rohit Grover 106:a20be740075d 31 /**************************************************************************/
Rohit Grover 106:a20be740075d 32 class GattServer
Rohit Grover 106:a20be740075d 33 {
Rohit Grover 106:a20be740075d 34 public:
rgrover1 140:407d134c179d 35 /* Event callback handlers. */
rgrover1 140:407d134c179d 36 typedef void (*EventCallback_t)(uint16_t attributeHandle);
rgrover1 140:407d134c179d 37 typedef void (*ServerEventCallback_t)(void); /**< independent of any particular attribute */
rgrover1 140:407d134c179d 38 typedef void (*ServerEventCallbackWithCount_t)(unsigned count); /**< independent of any particular attribute */
rgrover1 140:407d134c179d 39
rgrover1 140:407d134c179d 40 protected:
rgrover1 140:407d134c179d 41 GattServer() : serviceCount(0), characteristicCount(0), onDataSent(NULL), onDataWritten(), onUpdatesEnabled(NULL), onUpdatesDisabled(NULL), onConfirmationReceived(NULL) {
rgrover1 140:407d134c179d 42 /* empty */
rgrover1 140:407d134c179d 43 }
rgrover1 140:407d134c179d 44
rgrover1 140:407d134c179d 45 friend class BLEDevice;
rgrover1 140:407d134c179d 46 private:
Rohit Grover 106:a20be740075d 47 /* These functions must be defined in the sub-class */
Rohit Grover 106:a20be740075d 48 virtual ble_error_t addService(GattService &) = 0;
Rohit Grover 106:a20be740075d 49 virtual ble_error_t readValue(uint16_t handle, uint8_t buffer[], uint16_t *const lengthP) = 0;
Rohit Grover 106:a20be740075d 50 virtual ble_error_t updateValue(uint16_t, uint8_t[], uint16_t, bool localOnly = false) = 0;
rgrover1 140:407d134c179d 51 virtual ble_error_t initializeGATTDatabase(void) = 0;
Rohit Grover 106:a20be740075d 52
Rohit Grover 106:a20be740075d 53 // ToDo: For updateValue, check the CCCD to see if the value we are
Rohit Grover 106:a20be740075d 54 // updating has the notify or indicate bits sent, and if BOTH are set
Rohit Grover 106:a20be740075d 55 // be sure to call sd_ble_gatts_hvx() twice with notify then indicate!
Rohit Grover 106:a20be740075d 56 // Strange use case, but valid and must be covered!
Rohit Grover 106:a20be740075d 57
Rohit Grover 116:ca826083980e 58 void setOnDataSent(ServerEventCallbackWithCount_t callback) {
Rohit Grover 106:a20be740075d 59 onDataSent = callback;
Rohit Grover 106:a20be740075d 60 }
Rohit Grover 118:620d28e7a1ba 61 void setOnDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP)) {
Rohit Grover 118:620d28e7a1ba 62 onDataWritten.add(callback);
Rohit Grover 118:620d28e7a1ba 63 }
Rohit Grover 118:620d28e7a1ba 64 template <typename T>
Rohit Grover 118:620d28e7a1ba 65 void setOnDataWritten(T *objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context)) {
Rohit Grover 118:620d28e7a1ba 66 onDataWritten.add(objPtr, memberPtr);
Rohit Grover 106:a20be740075d 67 }
Rohit Grover 106:a20be740075d 68 void setOnUpdatesEnabled(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 69 onUpdatesEnabled = callback;
Rohit Grover 106:a20be740075d 70 }
Rohit Grover 106:a20be740075d 71 void setOnUpdatesDisabled(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 72 onUpdatesDisabled = callback;
Rohit Grover 106:a20be740075d 73 }
Rohit Grover 106:a20be740075d 74 void setOnConfirmationReceived(EventCallback_t callback) {
Rohit Grover 106:a20be740075d 75 onConfirmationReceived = callback;
Rohit Grover 106:a20be740075d 76 }
Rohit Grover 106:a20be740075d 77
rgrover1 140:407d134c179d 78 protected:
Rohit Grover 118:620d28e7a1ba 79 void handleDataWrittenEvent(const GattCharacteristicWriteCBParams *params) {
Rohit Grover 118:620d28e7a1ba 80 if (onDataWritten.hasCallbacksAttached()) {
Rohit Grover 118:620d28e7a1ba 81 onDataWritten.call(params);
Rohit Grover 116:ca826083980e 82 }
Rohit Grover 116:ca826083980e 83 }
Rohit Grover 116:ca826083980e 84
Rohit Grover 106:a20be740075d 85 void handleEvent(GattServerEvents::gattEvent_e type, uint16_t charHandle) {
Rohit Grover 106:a20be740075d 86 switch (type) {
Rohit Grover 106:a20be740075d 87 case GattServerEvents::GATT_EVENT_UPDATES_ENABLED:
Rohit Grover 106:a20be740075d 88 if (onUpdatesEnabled) {
Rohit Grover 106:a20be740075d 89 onUpdatesEnabled(charHandle);
Rohit Grover 106:a20be740075d 90 }
Rohit Grover 106:a20be740075d 91 break;
Rohit Grover 106:a20be740075d 92 case GattServerEvents::GATT_EVENT_UPDATES_DISABLED:
Rohit Grover 106:a20be740075d 93 if (onUpdatesDisabled) {
Rohit Grover 106:a20be740075d 94 onUpdatesDisabled(charHandle);
Rohit Grover 106:a20be740075d 95 }
Rohit Grover 106:a20be740075d 96 break;
Rohit Grover 106:a20be740075d 97 case GattServerEvents::GATT_EVENT_CONFIRMATION_RECEIVED:
Rohit Grover 106:a20be740075d 98 if (onConfirmationReceived) {
Rohit Grover 106:a20be740075d 99 onConfirmationReceived(charHandle);
Rohit Grover 106:a20be740075d 100 }
Rohit Grover 106:a20be740075d 101 break;
Rohit Grover 106:a20be740075d 102 }
Rohit Grover 106:a20be740075d 103 }
Rohit Grover 106:a20be740075d 104
Rohit Grover 116:ca826083980e 105 void handleDataSentEvent(unsigned count) {
Rohit Grover 116:ca826083980e 106 if (onDataSent) {
Rohit Grover 116:ca826083980e 107 onDataSent(count);
Rohit Grover 106:a20be740075d 108 }
Rohit Grover 106:a20be740075d 109 }
Rohit Grover 106:a20be740075d 110
Rohit Grover 106:a20be740075d 111 protected:
Rohit Grover 106:a20be740075d 112 uint8_t serviceCount;
Rohit Grover 106:a20be740075d 113 uint8_t characteristicCount;
Rohit Grover 106:a20be740075d 114
Rohit Grover 106:a20be740075d 115 private:
Rohit Grover 116:ca826083980e 116 ServerEventCallbackWithCount_t onDataSent;
Rohit Grover 118:620d28e7a1ba 117 CallChainOfFunctionPointersWithContext<const GattCharacteristicWriteCBParams *> onDataWritten;
Rohit Grover 116:ca826083980e 118 EventCallback_t onUpdatesEnabled;
Rohit Grover 116:ca826083980e 119 EventCallback_t onUpdatesDisabled;
Rohit Grover 116:ca826083980e 120 EventCallback_t onConfirmationReceived;
rgrover1 140:407d134c179d 121
rgrover1 140:407d134c179d 122 private:
rgrover1 140:407d134c179d 123 /* disallow copy and assginment */
rgrover1 140:407d134c179d 124 GattServer(const GattServer &);
rgrover1 140:407d134c179d 125 GattServer& operator=(const GattServer &);
Rohit Grover 106:a20be740075d 126 };
Rohit Grover 106:a20be740075d 127
rgrover1 126:fdebe4d5d62f 128 #endif // ifndef __GATT_SERVER_H__