Microbug / BLE_API_FOTA

Lightly modified version of the BLE stack, that doesn't bring up a DFUService by default... as we have our own.

Fork of BLE_API by Bluetooth Low Energy

public/GattServer.h@328:1fd12f67ed7a, 2015-04-15 (annotated)

Committer:
rgrover1
Date:
Wed Apr 15 09:05:09 2015 +0100
Revision:
328:1fd12f67ed7a
Parent:
301:54c87189e423
Child:
340:c7684a5bc2e1
Synchronized with git rev 7e9fc2ae

Author: Rohit Grover

minor parameter renames and removal of un-necessary consts

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 258:85de85adfac7 1 /* mbed Microcontroller Library
rgrover1 258:85de85adfac7 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 258:85de85adfac7 3 *
rgrover1 258:85de85adfac7 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 258:85de85adfac7 5 * you may not use this file except in compliance with the License.
rgrover1 258:85de85adfac7 6 * You may obtain a copy of the License at
rgrover1 258:85de85adfac7 7 *
rgrover1 258:85de85adfac7 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 258:85de85adfac7 9 *
rgrover1 258:85de85adfac7 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 258:85de85adfac7 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 258:85de85adfac7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 258:85de85adfac7 13 * See the License for the specific language governing permissions and
rgrover1 258:85de85adfac7 14 * limitations under the License.
rgrover1 258:85de85adfac7 15 */
rgrover1 258:85de85adfac7 16
rgrover1 258:85de85adfac7 17 #ifndef __GATT_SERVER_H__
rgrover1 258:85de85adfac7 18 #define __GATT_SERVER_H__
rgrover1 258:85de85adfac7 19
rgrover1 258:85de85adfac7 20 #include "GattService.h"
rgrover1 258:85de85adfac7 21 #include "GattServerEvents.h"
rgrover1 264:eea11cfb6753 22 #include "GattCharacteristicCallbackParams.h"
rgrover1 258:85de85adfac7 23 #include "CallChainOfFunctionPointersWithContext.h"
rgrover1 258:85de85adfac7 24
rgrover1 258:85de85adfac7 25 class GattServer {
rgrover1 258:85de85adfac7 26 public:
rgrover1 258:85de85adfac7 27 /* Event callback handlers. */
rgrover1 258:85de85adfac7 28 typedef void (*EventCallback_t)(uint16_t attributeHandle);
rgrover1 258:85de85adfac7 29 typedef void (*ServerEventCallback_t)(void); /**< independent of any particular attribute */
rgrover1 258:85de85adfac7 30
rgrover1 258:85de85adfac7 31 protected:
rgrover1 263:73847e8b6025 32 GattServer() :
rgrover1 263:73847e8b6025 33 serviceCount(0),
rgrover1 263:73847e8b6025 34 characteristicCount(0),
rgrover1 263:73847e8b6025 35 onDataSent(),
rgrover1 263:73847e8b6025 36 onDataWritten(),
rgrover1 300:d9a39f759a6a 37 onDataRead(),
rgrover1 263:73847e8b6025 38 onUpdatesEnabled(NULL),
rgrover1 263:73847e8b6025 39 onUpdatesDisabled(NULL),
rgrover1 263:73847e8b6025 40 onConfirmationReceived(NULL) {
rgrover1 258:85de85adfac7 41 /* empty */
rgrover1 258:85de85adfac7 42 }
rgrover1 258:85de85adfac7 43
rgrover1 258:85de85adfac7 44 friend class BLEDevice;
rgrover1 258:85de85adfac7 45 private:
rgrover1 258:85de85adfac7 46 /* These functions must be defined in the sub-class */
rgrover1 328:1fd12f67ed7a 47 virtual ble_error_t addService(GattService &) = 0;
rgrover1 328:1fd12f67ed7a 48 virtual ble_error_t readValue(GattAttribute::Handle_t attributeHandle, uint8_t buffer[], uint16_t *lengthP) = 0;
rgrover1 328:1fd12f67ed7a 49 virtual ble_error_t updateValue(GattAttribute::Handle_t, const uint8_t[], uint16_t, bool localOnly = false) = 0;
rgrover1 328:1fd12f67ed7a 50 virtual ble_error_t initializeGATTDatabase(void) = 0;
rgrover1 258:85de85adfac7 51
rgrover1 258:85de85adfac7 52 // ToDo: For updateValue, check the CCCD to see if the value we are
rgrover1 258:85de85adfac7 53 // updating has the notify or indicate bits sent, and if BOTH are set
rgrover1 258:85de85adfac7 54 // be sure to call sd_ble_gatts_hvx() twice with notify then indicate!
rgrover1 258:85de85adfac7 55 // Strange use case, but valid and must be covered!
rgrover1 258:85de85adfac7 56
rgrover1 259:a95264ad705c 57 void setOnDataSent(void (*callback)(unsigned count)) {onDataSent.add(callback);}
rgrover1 259:a95264ad705c 58 template <typename T>
rgrover1 259:a95264ad705c 59 void setOnDataSent(T *objPtr, void (T::*memberPtr)(unsigned count)) {
rgrover1 259:a95264ad705c 60 onDataSent.add(objPtr, memberPtr);
rgrover1 259:a95264ad705c 61 }
rgrover1 258:85de85adfac7 62 void setOnDataWritten(void (*callback)(const GattCharacteristicWriteCBParams *eventDataP)) {onDataWritten.add(callback);}
rgrover1 258:85de85adfac7 63 template <typename T>
rgrover1 258:85de85adfac7 64 void setOnDataWritten(T *objPtr, void (T::*memberPtr)(const GattCharacteristicWriteCBParams *context)) {
rgrover1 258:85de85adfac7 65 onDataWritten.add(objPtr, memberPtr);
rgrover1 258:85de85adfac7 66 }
rgrover1 300:d9a39f759a6a 67
rgrover1 300:d9a39f759a6a 68 /**
rgrover1 300:d9a39f759a6a 69 * A virtual function to allow underlying stacks to indicate if they support
rgrover1 300:d9a39f759a6a 70 * onDataRead(). It should be overridden to return true as applicable.
rgrover1 300:d9a39f759a6a 71 */
rgrover1 301:54c87189e423 72 virtual bool isOnDataReadAvailable() const {
rgrover1 300:d9a39f759a6a 73 return false;
rgrover1 300:d9a39f759a6a 74 }
rgrover1 300:d9a39f759a6a 75 ble_error_t setOnDataRead(void (*callback)(const GattCharacteristicReadCBParams *eventDataP)) {
rgrover1 301:54c87189e423 76 if (!isOnDataReadAvailable()) {
rgrover1 300:d9a39f759a6a 77 return BLE_ERROR_NOT_IMPLEMENTED;
rgrover1 300:d9a39f759a6a 78 }
rgrover1 300:d9a39f759a6a 79
rgrover1 300:d9a39f759a6a 80 onDataRead.add(callback);
rgrover1 300:d9a39f759a6a 81 return BLE_ERROR_NONE;
rgrover1 300:d9a39f759a6a 82 }
rgrover1 300:d9a39f759a6a 83 template <typename T>
rgrover1 300:d9a39f759a6a 84 ble_error_t setOnDataRead(T *objPtr, void (T::*memberPtr)(const GattCharacteristicReadCBParams *context)) {
rgrover1 301:54c87189e423 85 if (!isOnDataReadAvailable()) {
rgrover1 300:d9a39f759a6a 86 return BLE_ERROR_NOT_IMPLEMENTED;
rgrover1 300:d9a39f759a6a 87 }
rgrover1 300:d9a39f759a6a 88
rgrover1 300:d9a39f759a6a 89 onDataRead.add(objPtr, memberPtr);
rgrover1 300:d9a39f759a6a 90 return BLE_ERROR_NONE;
rgrover1 300:d9a39f759a6a 91 }
rgrover1 258:85de85adfac7 92 void setOnUpdatesEnabled(EventCallback_t callback) {onUpdatesEnabled = callback;}
rgrover1 258:85de85adfac7 93 void setOnUpdatesDisabled(EventCallback_t callback) {onUpdatesDisabled = callback;}
rgrover1 258:85de85adfac7 94 void setOnConfirmationReceived(EventCallback_t callback) {onConfirmationReceived = callback;}
rgrover1 258:85de85adfac7 95
rgrover1 258:85de85adfac7 96 protected:
rgrover1 258:85de85adfac7 97 void handleDataWrittenEvent(const GattCharacteristicWriteCBParams *params) {
rgrover1 258:85de85adfac7 98 if (onDataWritten.hasCallbacksAttached()) {
rgrover1 258:85de85adfac7 99 onDataWritten.call(params);
rgrover1 258:85de85adfac7 100 }
rgrover1 258:85de85adfac7 101 }
rgrover1 258:85de85adfac7 102
rgrover1 300:d9a39f759a6a 103 void handleDataReadEvent(const GattCharacteristicReadCBParams *params) {
rgrover1 300:d9a39f759a6a 104 if (onDataRead.hasCallbacksAttached()) {
rgrover1 300:d9a39f759a6a 105 onDataRead.call(params);
rgrover1 300:d9a39f759a6a 106 }
rgrover1 300:d9a39f759a6a 107 }
rgrover1 300:d9a39f759a6a 108
rgrover1 258:85de85adfac7 109 void handleEvent(GattServerEvents::gattEvent_e type, uint16_t charHandle) {
rgrover1 258:85de85adfac7 110 switch (type) {
rgrover1 258:85de85adfac7 111 case GattServerEvents::GATT_EVENT_UPDATES_ENABLED:
rgrover1 258:85de85adfac7 112 if (onUpdatesEnabled) {
rgrover1 258:85de85adfac7 113 onUpdatesEnabled(charHandle);
rgrover1 258:85de85adfac7 114 }
rgrover1 258:85de85adfac7 115 break;
rgrover1 258:85de85adfac7 116 case GattServerEvents::GATT_EVENT_UPDATES_DISABLED:
rgrover1 258:85de85adfac7 117 if (onUpdatesDisabled) {
rgrover1 258:85de85adfac7 118 onUpdatesDisabled(charHandle);
rgrover1 258:85de85adfac7 119 }
rgrover1 258:85de85adfac7 120 break;
rgrover1 258:85de85adfac7 121 case GattServerEvents::GATT_EVENT_CONFIRMATION_RECEIVED:
rgrover1 258:85de85adfac7 122 if (onConfirmationReceived) {
rgrover1 258:85de85adfac7 123 onConfirmationReceived(charHandle);
rgrover1 258:85de85adfac7 124 }
rgrover1 258:85de85adfac7 125 break;
rgrover1 267:ad6f6f40eb24 126 default:
rgrover1 267:ad6f6f40eb24 127 break;
rgrover1 258:85de85adfac7 128 }
rgrover1 258:85de85adfac7 129 }
rgrover1 258:85de85adfac7 130
rgrover1 258:85de85adfac7 131 void handleDataSentEvent(unsigned count) {
rgrover1 259:a95264ad705c 132 if (onDataSent.hasCallbacksAttached()) {
rgrover1 259:a95264ad705c 133 onDataSent.call(count);
rgrover1 258:85de85adfac7 134 }
rgrover1 258:85de85adfac7 135 }
rgrover1 258:85de85adfac7 136
rgrover1 258:85de85adfac7 137 protected:
rgrover1 258:85de85adfac7 138 uint8_t serviceCount;
rgrover1 258:85de85adfac7 139 uint8_t characteristicCount;
rgrover1 258:85de85adfac7 140
rgrover1 258:85de85adfac7 141 private:
rgrover1 259:a95264ad705c 142 CallChainOfFunctionPointersWithContext<unsigned> onDataSent;
rgrover1 258:85de85adfac7 143 CallChainOfFunctionPointersWithContext<const GattCharacteristicWriteCBParams *> onDataWritten;
rgrover1 300:d9a39f759a6a 144 CallChainOfFunctionPointersWithContext<const GattCharacteristicReadCBParams *> onDataRead;
rgrover1 262:1749228403b7 145 EventCallback_t onUpdatesEnabled;
rgrover1 262:1749228403b7 146 EventCallback_t onUpdatesDisabled;
rgrover1 262:1749228403b7 147 EventCallback_t onConfirmationReceived;
rgrover1 258:85de85adfac7 148
rgrover1 258:85de85adfac7 149 private:
rgrover1 258:85de85adfac7 150 /* disallow copy and assignment */
rgrover1 258:85de85adfac7 151 GattServer(const GattServer &);
rgrover1 258:85de85adfac7 152 GattServer& operator=(const GattServer &);
rgrover1 258:85de85adfac7 153 };
rgrover1 258:85de85adfac7 154
rgrover1 258:85de85adfac7 155 #endif // ifndef __GATT_SERVER_H__