Lee Kai Xuan
/
mbed-os
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
mbed-os
by 
erkin yucel
features/FEATURE_BLE/ble/GattClient.h@0:f269e3021894, 2016-10-23 (annotated)
- Committer:
- elessair
- Date:
- Sun Oct 23 15:10:02 2016 +0000
- Revision:
- 0:f269e3021894
Initial commit
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| elessair | 0:f269e3021894 | 1 | /* mbed Microcontroller Library |
| elessair | 0:f269e3021894 | 2 | * Copyright (c) 2006-2013 ARM Limited |
| elessair | 0:f269e3021894 | 3 | * |
| elessair | 0:f269e3021894 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| elessair | 0:f269e3021894 | 5 | * you may not use this file except in compliance with the License. |
| elessair | 0:f269e3021894 | 6 | * You may obtain a copy of the License at |
| elessair | 0:f269e3021894 | 7 | * |
| elessair | 0:f269e3021894 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| elessair | 0:f269e3021894 | 9 | * |
| elessair | 0:f269e3021894 | 10 | * Unless required by applicable law or agreed to in writing, software |
| elessair | 0:f269e3021894 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| elessair | 0:f269e3021894 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| elessair | 0:f269e3021894 | 13 | * See the License for the specific language governing permissions and |
| elessair | 0:f269e3021894 | 14 | * limitations under the License. |
| elessair | 0:f269e3021894 | 15 | */ |
| elessair | 0:f269e3021894 | 16 | |
| elessair | 0:f269e3021894 | 17 | #ifndef __GATT_CLIENT_H__ |
| elessair | 0:f269e3021894 | 18 | #define __GATT_CLIENT_H__ |
| elessair | 0:f269e3021894 | 19 | |
| elessair | 0:f269e3021894 | 20 | #include "Gap.h" |
| elessair | 0:f269e3021894 | 21 | #include "GattAttribute.h" |
| elessair | 0:f269e3021894 | 22 | #include "ServiceDiscovery.h" |
| elessair | 0:f269e3021894 | 23 | #include "CharacteristicDescriptorDiscovery.h" |
| elessair | 0:f269e3021894 | 24 | |
| elessair | 0:f269e3021894 | 25 | #include "GattCallbackParamTypes.h" |
| elessair | 0:f269e3021894 | 26 | |
| elessair | 0:f269e3021894 | 27 | #include "CallChainOfFunctionPointersWithContext.h" |
| elessair | 0:f269e3021894 | 28 | |
| elessair | 0:f269e3021894 | 29 | class GattClient { |
| elessair | 0:f269e3021894 | 30 | public: |
| elessair | 0:f269e3021894 | 31 | /** |
| elessair | 0:f269e3021894 | 32 | * Type for the registered callbacks added to the data read callchain. |
| elessair | 0:f269e3021894 | 33 | * Refer to GattClient::onDataRead(). |
| elessair | 0:f269e3021894 | 34 | */ |
| elessair | 0:f269e3021894 | 35 | typedef FunctionPointerWithContext<const GattReadCallbackParams*> ReadCallback_t; |
| elessair | 0:f269e3021894 | 36 | /** |
| elessair | 0:f269e3021894 | 37 | * Type for the data read event callchain. Refer to GattClient::onDataRead(). |
| elessair | 0:f269e3021894 | 38 | */ |
| elessair | 0:f269e3021894 | 39 | typedef CallChainOfFunctionPointersWithContext<const GattReadCallbackParams*> ReadCallbackChain_t; |
| elessair | 0:f269e3021894 | 40 | |
| elessair | 0:f269e3021894 | 41 | /** |
| elessair | 0:f269e3021894 | 42 | * Enumerator for write operations. |
| elessair | 0:f269e3021894 | 43 | */ |
| elessair | 0:f269e3021894 | 44 | enum WriteOp_t { |
| elessair | 0:f269e3021894 | 45 | GATT_OP_WRITE_REQ = 0x01, /**< Write request. */ |
| elessair | 0:f269e3021894 | 46 | GATT_OP_WRITE_CMD = 0x02, /**< Write command. */ |
| elessair | 0:f269e3021894 | 47 | }; |
| elessair | 0:f269e3021894 | 48 | |
| elessair | 0:f269e3021894 | 49 | /** |
| elessair | 0:f269e3021894 | 50 | * Type for the registered callbacks added to the data write callchain. |
| elessair | 0:f269e3021894 | 51 | * Refer to GattClient::onDataWrite(). |
| elessair | 0:f269e3021894 | 52 | */ |
| elessair | 0:f269e3021894 | 53 | typedef FunctionPointerWithContext<const GattWriteCallbackParams*> WriteCallback_t; |
| elessair | 0:f269e3021894 | 54 | /** |
| elessair | 0:f269e3021894 | 55 | * Type for the data write event callchain. Refer to GattClient::onDataWrite(). |
| elessair | 0:f269e3021894 | 56 | */ |
| elessair | 0:f269e3021894 | 57 | typedef CallChainOfFunctionPointersWithContext<const GattWriteCallbackParams*> WriteCallbackChain_t; |
| elessair | 0:f269e3021894 | 58 | |
| elessair | 0:f269e3021894 | 59 | /** |
| elessair | 0:f269e3021894 | 60 | * Type for the registered callbacks added to the update event callchain. |
| elessair | 0:f269e3021894 | 61 | * Refer to GattClient::onHVX(). |
| elessair | 0:f269e3021894 | 62 | */ |
| elessair | 0:f269e3021894 | 63 | typedef FunctionPointerWithContext<const GattHVXCallbackParams*> HVXCallback_t; |
| elessair | 0:f269e3021894 | 64 | /** |
| elessair | 0:f269e3021894 | 65 | * Type for the update event callchain. Refer to GattClient::onHVX(). |
| elessair | 0:f269e3021894 | 66 | */ |
| elessair | 0:f269e3021894 | 67 | typedef CallChainOfFunctionPointersWithContext<const GattHVXCallbackParams*> HVXCallbackChain_t; |
| elessair | 0:f269e3021894 | 68 | |
| elessair | 0:f269e3021894 | 69 | /** |
| elessair | 0:f269e3021894 | 70 | * Type for the registered callbacks added to the shutdown callchain. |
| elessair | 0:f269e3021894 | 71 | * Refer to GattClient::onShutdown(). |
| elessair | 0:f269e3021894 | 72 | */ |
| elessair | 0:f269e3021894 | 73 | typedef FunctionPointerWithContext<const GattClient *> GattClientShutdownCallback_t; |
| elessair | 0:f269e3021894 | 74 | /** |
| elessair | 0:f269e3021894 | 75 | * Type for the shutdown event callchain. Refer to GattClient::onShutown(). |
| elessair | 0:f269e3021894 | 76 | */ |
| elessair | 0:f269e3021894 | 77 | typedef CallChainOfFunctionPointersWithContext<const GattClient *> GattClientShutdownCallbackChain_t; |
| elessair | 0:f269e3021894 | 78 | |
| elessair | 0:f269e3021894 | 79 | /* |
| elessair | 0:f269e3021894 | 80 | * The following functions are meant to be overridden in the platform-specific sub-class. |
| elessair | 0:f269e3021894 | 81 | */ |
| elessair | 0:f269e3021894 | 82 | public: |
| elessair | 0:f269e3021894 | 83 | /** |
| elessair | 0:f269e3021894 | 84 | * Launch service discovery. Once launched, application callbacks will be |
| elessair | 0:f269e3021894 | 85 | * invoked for matching services or characteristics. isServiceDiscoveryActive() |
| elessair | 0:f269e3021894 | 86 | * can be used to determine status, and a termination callback (if one was set up) |
| elessair | 0:f269e3021894 | 87 | * will be invoked at the end. Service discovery can be terminated prematurely, |
| elessair | 0:f269e3021894 | 88 | * if needed, using terminateServiceDiscovery(). |
| elessair | 0:f269e3021894 | 89 | * |
| elessair | 0:f269e3021894 | 90 | * @param[in] connectionHandle |
| elessair | 0:f269e3021894 | 91 | * Handle for the connection with the peer. |
| elessair | 0:f269e3021894 | 92 | * @param[in] sc |
| elessair | 0:f269e3021894 | 93 | * This is the application callback for a matching service. Taken as |
| elessair | 0:f269e3021894 | 94 | * NULL by default. Note: service discovery may still be active |
| elessair | 0:f269e3021894 | 95 | * when this callback is issued; calling asynchronous BLE-stack |
| elessair | 0:f269e3021894 | 96 | * APIs from within this application callback might cause the |
| elessair | 0:f269e3021894 | 97 | * stack to abort service discovery. If this becomes an issue, it |
| elessair | 0:f269e3021894 | 98 | * may be better to make a local copy of the discoveredService and |
| elessair | 0:f269e3021894 | 99 | * wait for service discovery to terminate before operating on the |
| elessair | 0:f269e3021894 | 100 | * service. |
| elessair | 0:f269e3021894 | 101 | * @param[in] cc |
| elessair | 0:f269e3021894 | 102 | * This is the application callback for a matching characteristic. |
| elessair | 0:f269e3021894 | 103 | * Taken as NULL by default. Note: service discovery may still be |
| elessair | 0:f269e3021894 | 104 | * active when this callback is issued; calling asynchronous |
| elessair | 0:f269e3021894 | 105 | * BLE-stack APIs from within this application callback might cause |
| elessair | 0:f269e3021894 | 106 | * the stack to abort service discovery. If this becomes an issue, |
| elessair | 0:f269e3021894 | 107 | * it may be better to make a local copy of the discoveredCharacteristic |
| elessair | 0:f269e3021894 | 108 | * and wait for service discovery to terminate before operating on the |
| elessair | 0:f269e3021894 | 109 | * characteristic. |
| elessair | 0:f269e3021894 | 110 | * @param[in] matchingServiceUUID |
| elessair | 0:f269e3021894 | 111 | * UUID-based filter for specifying a service in which the application is |
| elessair | 0:f269e3021894 | 112 | * interested. By default it is set as the wildcard UUID_UNKNOWN, |
| elessair | 0:f269e3021894 | 113 | * in which case it matches all services. If characteristic-UUID |
| elessair | 0:f269e3021894 | 114 | * filter (below) is set to the wildcard value, then a service |
| elessair | 0:f269e3021894 | 115 | * callback will be invoked for the matching service (or for every |
| elessair | 0:f269e3021894 | 116 | * service if the service filter is a wildcard). |
| elessair | 0:f269e3021894 | 117 | * @param[in] matchingCharacteristicUUIDIn |
| elessair | 0:f269e3021894 | 118 | * UUID-based filter for specifying characteristic in which the application |
| elessair | 0:f269e3021894 | 119 | * is interested. By default it is set as the wildcard UUID_UKNOWN |
| elessair | 0:f269e3021894 | 120 | * to match against any characteristic. If both service-UUID |
| elessair | 0:f269e3021894 | 121 | * filter and characteristic-UUID filter are used with non-wildcard |
| elessair | 0:f269e3021894 | 122 | * values, then only a single characteristic callback is |
| elessair | 0:f269e3021894 | 123 | * invoked for the matching characteristic. |
| elessair | 0:f269e3021894 | 124 | * |
| elessair | 0:f269e3021894 | 125 | * @note Using wildcard values for both service-UUID and characteristic- |
| elessair | 0:f269e3021894 | 126 | * UUID will result in complete service discovery: callbacks being |
| elessair | 0:f269e3021894 | 127 | * called for every service and characteristic. |
| elessair | 0:f269e3021894 | 128 | * |
| elessair | 0:f269e3021894 | 129 | * @note Providing NULL for the characteristic callback will result in |
| elessair | 0:f269e3021894 | 130 | * characteristic discovery being skipped for each matching |
| elessair | 0:f269e3021894 | 131 | * service. This allows for an inexpensive method to discover only |
| elessair | 0:f269e3021894 | 132 | * services. |
| elessair | 0:f269e3021894 | 133 | * |
| elessair | 0:f269e3021894 | 134 | * @return |
| elessair | 0:f269e3021894 | 135 | * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error. |
| elessair | 0:f269e3021894 | 136 | */ |
| elessair | 0:f269e3021894 | 137 | virtual ble_error_t launchServiceDiscovery(Gap::Handle_t connectionHandle, |
| elessair | 0:f269e3021894 | 138 | ServiceDiscovery::ServiceCallback_t sc = NULL, |
| elessair | 0:f269e3021894 | 139 | ServiceDiscovery::CharacteristicCallback_t cc = NULL, |
| elessair | 0:f269e3021894 | 140 | const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN), |
| elessair | 0:f269e3021894 | 141 | const UUID &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) { |
| elessair | 0:f269e3021894 | 142 | /* Avoid compiler warnings about unused variables. */ |
| elessair | 0:f269e3021894 | 143 | (void)connectionHandle; |
| elessair | 0:f269e3021894 | 144 | (void)sc; |
| elessair | 0:f269e3021894 | 145 | (void)cc; |
| elessair | 0:f269e3021894 | 146 | (void)matchingServiceUUID; |
| elessair | 0:f269e3021894 | 147 | (void)matchingCharacteristicUUIDIn; |
| elessair | 0:f269e3021894 | 148 | |
| elessair | 0:f269e3021894 | 149 | return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 150 | } |
| elessair | 0:f269e3021894 | 151 | |
| elessair | 0:f269e3021894 | 152 | /** |
| elessair | 0:f269e3021894 | 153 | * Launch service discovery for services. Once launched, service discovery will remain |
| elessair | 0:f269e3021894 | 154 | * active with service-callbacks being issued back into the application for matching |
| elessair | 0:f269e3021894 | 155 | * services. isServiceDiscoveryActive() can be used to |
| elessair | 0:f269e3021894 | 156 | * determine status, and a termination callback (if set up) will be invoked |
| elessair | 0:f269e3021894 | 157 | * at the end. Service discovery can be terminated prematurely, if needed, |
| elessair | 0:f269e3021894 | 158 | * using terminateServiceDiscovery(). |
| elessair | 0:f269e3021894 | 159 | * |
| elessair | 0:f269e3021894 | 160 | * @param[in] connectionHandle |
| elessair | 0:f269e3021894 | 161 | * Handle for the connection with the peer. |
| elessair | 0:f269e3021894 | 162 | * @param[in] callback |
| elessair | 0:f269e3021894 | 163 | * This is the application callback for a matching service. |
| elessair | 0:f269e3021894 | 164 | * Note: service discovery may still be active |
| elessair | 0:f269e3021894 | 165 | * when this callback is issued; calling asynchronous BLE-stack |
| elessair | 0:f269e3021894 | 166 | * APIs from within this application callback might cause the |
| elessair | 0:f269e3021894 | 167 | * stack to abort service discovery. If this becomes an issue, it |
| elessair | 0:f269e3021894 | 168 | * may be better to make a local copy of the discoveredService and |
| elessair | 0:f269e3021894 | 169 | * wait for service discovery to terminate before operating on the |
| elessair | 0:f269e3021894 | 170 | * service. |
| elessair | 0:f269e3021894 | 171 | * @param[in] matchingServiceUUID |
| elessair | 0:f269e3021894 | 172 | * UUID-based filter for specifying a service in which the application is |
| elessair | 0:f269e3021894 | 173 | * interested. By default it is set as the wildcard UUID_UNKNOWN, |
| elessair | 0:f269e3021894 | 174 | * in which case it matches all services. |
| elessair | 0:f269e3021894 | 175 | * |
| elessair | 0:f269e3021894 | 176 | * @return |
| elessair | 0:f269e3021894 | 177 | * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error. |
| elessair | 0:f269e3021894 | 178 | */ |
| elessair | 0:f269e3021894 | 179 | virtual ble_error_t discoverServices(Gap::Handle_t connectionHandle, |
| elessair | 0:f269e3021894 | 180 | ServiceDiscovery::ServiceCallback_t callback, |
| elessair | 0:f269e3021894 | 181 | const UUID &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) { |
| elessair | 0:f269e3021894 | 182 | return launchServiceDiscovery(connectionHandle, callback, NULL, matchingServiceUUID); /* We take advantage of the property |
| elessair | 0:f269e3021894 | 183 | * that providing NULL for the characteristic callback will result in |
| elessair | 0:f269e3021894 | 184 | * characteristic discovery being skipped for each matching |
| elessair | 0:f269e3021894 | 185 | * service. This allows for an inexpensive method to discover only |
| elessair | 0:f269e3021894 | 186 | * services. Porters are free to override this. */ |
| elessair | 0:f269e3021894 | 187 | } |
| elessair | 0:f269e3021894 | 188 | |
| elessair | 0:f269e3021894 | 189 | /** |
| elessair | 0:f269e3021894 | 190 | * Launch service discovery for services. Once launched, service discovery will remain |
| elessair | 0:f269e3021894 | 191 | * active with service-callbacks being issued back into the application for matching |
| elessair | 0:f269e3021894 | 192 | * services. isServiceDiscoveryActive() can be used to |
| elessair | 0:f269e3021894 | 193 | * determine status, and a termination callback (if set up) will be invoked |
| elessair | 0:f269e3021894 | 194 | * at the end. Service discovery can be terminated prematurely, if needed, |
| elessair | 0:f269e3021894 | 195 | * using terminateServiceDiscovery(). |
| elessair | 0:f269e3021894 | 196 | * |
| elessair | 0:f269e3021894 | 197 | * @param[in] connectionHandle |
| elessair | 0:f269e3021894 | 198 | * Handle for the connection with the peer. |
| elessair | 0:f269e3021894 | 199 | * @param[in] callback |
| elessair | 0:f269e3021894 | 200 | * This is the application callback for a matching service. |
| elessair | 0:f269e3021894 | 201 | * Note: service discovery may still be active |
| elessair | 0:f269e3021894 | 202 | * when this callback is issued; calling asynchronous BLE-stack |
| elessair | 0:f269e3021894 | 203 | * APIs from within this application callback might cause the |
| elessair | 0:f269e3021894 | 204 | * stack to abort service discovery. If this becomes an issue, it |
| elessair | 0:f269e3021894 | 205 | * may be better to make a local copy of the discoveredService and |
| elessair | 0:f269e3021894 | 206 | * wait for service discovery to terminate before operating on the |
| elessair | 0:f269e3021894 | 207 | * service. |
| elessair | 0:f269e3021894 | 208 | * @param[in] startHandle, endHandle |
| elessair | 0:f269e3021894 | 209 | * Handle range within which to limit the search. |
| elessair | 0:f269e3021894 | 210 | * |
| elessair | 0:f269e3021894 | 211 | * @return |
| elessair | 0:f269e3021894 | 212 | * BLE_ERROR_NONE if service discovery is launched successfully; else an appropriate error. |
| elessair | 0:f269e3021894 | 213 | */ |
| elessair | 0:f269e3021894 | 214 | virtual ble_error_t discoverServices(Gap::Handle_t connectionHandle, |
| elessair | 0:f269e3021894 | 215 | ServiceDiscovery::ServiceCallback_t callback, |
| elessair | 0:f269e3021894 | 216 | GattAttribute::Handle_t startHandle, |
| elessair | 0:f269e3021894 | 217 | GattAttribute::Handle_t endHandle) { |
| elessair | 0:f269e3021894 | 218 | /* Avoid compiler warnings about unused variables. */ |
| elessair | 0:f269e3021894 | 219 | (void)connectionHandle; |
| elessair | 0:f269e3021894 | 220 | (void)callback; |
| elessair | 0:f269e3021894 | 221 | (void)startHandle; |
| elessair | 0:f269e3021894 | 222 | (void)endHandle; |
| elessair | 0:f269e3021894 | 223 | |
| elessair | 0:f269e3021894 | 224 | return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 225 | } |
| elessair | 0:f269e3021894 | 226 | |
| elessair | 0:f269e3021894 | 227 | /** |
| elessair | 0:f269e3021894 | 228 | * Check if service-discovery is currently active. |
| elessair | 0:f269e3021894 | 229 | * |
| elessair | 0:f269e3021894 | 230 | * @return true if service-discovery is active, false otherwise. |
| elessair | 0:f269e3021894 | 231 | */ |
| elessair | 0:f269e3021894 | 232 | virtual bool isServiceDiscoveryActive(void) const { |
| elessair | 0:f269e3021894 | 233 | return false; /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 234 | } |
| elessair | 0:f269e3021894 | 235 | |
| elessair | 0:f269e3021894 | 236 | /** |
| elessair | 0:f269e3021894 | 237 | * Terminate an ongoing service discovery. This should result in an |
| elessair | 0:f269e3021894 | 238 | * invocation of TerminationCallback if service-discovery is active. |
| elessair | 0:f269e3021894 | 239 | */ |
| elessair | 0:f269e3021894 | 240 | virtual void terminateServiceDiscovery(void) { |
| elessair | 0:f269e3021894 | 241 | /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 242 | } |
| elessair | 0:f269e3021894 | 243 | |
| elessair | 0:f269e3021894 | 244 | /** |
| elessair | 0:f269e3021894 | 245 | * Initiate a GATT Client read procedure by attribute-handle. |
| elessair | 0:f269e3021894 | 246 | * |
| elessair | 0:f269e3021894 | 247 | * @param[in] connHandle |
| elessair | 0:f269e3021894 | 248 | * Handle for the connection with the peer. |
| elessair | 0:f269e3021894 | 249 | * @param[in] attributeHandle |
| elessair | 0:f269e3021894 | 250 | * Handle of the attribute to read data from. |
| elessair | 0:f269e3021894 | 251 | * @param[in] offset |
| elessair | 0:f269e3021894 | 252 | * The offset from the start of the attribute value to be read. |
| elessair | 0:f269e3021894 | 253 | * |
| elessair | 0:f269e3021894 | 254 | * @return |
| elessair | 0:f269e3021894 | 255 | * BLE_ERROR_NONE if read procedure was successfully started. |
| elessair | 0:f269e3021894 | 256 | */ |
| elessair | 0:f269e3021894 | 257 | virtual ble_error_t read(Gap::Handle_t connHandle, GattAttribute::Handle_t attributeHandle, uint16_t offset) const { |
| elessair | 0:f269e3021894 | 258 | /* Avoid compiler warnings about unused variables. */ |
| elessair | 0:f269e3021894 | 259 | (void)connHandle; |
| elessair | 0:f269e3021894 | 260 | (void)attributeHandle; |
| elessair | 0:f269e3021894 | 261 | (void)offset; |
| elessair | 0:f269e3021894 | 262 | |
| elessair | 0:f269e3021894 | 263 | return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 264 | } |
| elessair | 0:f269e3021894 | 265 | |
| elessair | 0:f269e3021894 | 266 | /** |
| elessair | 0:f269e3021894 | 267 | * Initiate a GATT Client write procedure. |
| elessair | 0:f269e3021894 | 268 | * |
| elessair | 0:f269e3021894 | 269 | * @param[in] cmd |
| elessair | 0:f269e3021894 | 270 | * Command can be either a write-request (which generates a |
| elessair | 0:f269e3021894 | 271 | * matching response from the peripheral), or a write-command |
| elessair | 0:f269e3021894 | 272 | * (which doesn't require the connected peer to respond). |
| elessair | 0:f269e3021894 | 273 | * @param[in] connHandle |
| elessair | 0:f269e3021894 | 274 | * Connection handle. |
| elessair | 0:f269e3021894 | 275 | * @param[in] attributeHandle |
| elessair | 0:f269e3021894 | 276 | * Handle for the target attribtue on the remote GATT server. |
| elessair | 0:f269e3021894 | 277 | * @param[in] length |
| elessair | 0:f269e3021894 | 278 | * Length of the new value. |
| elessair | 0:f269e3021894 | 279 | * @param[in] value |
| elessair | 0:f269e3021894 | 280 | * New value being written. |
| elessair | 0:f269e3021894 | 281 | * |
| elessair | 0:f269e3021894 | 282 | * @return |
| elessair | 0:f269e3021894 | 283 | * BLE_ERROR_NONE if write procedure was successfully started. |
| elessair | 0:f269e3021894 | 284 | */ |
| elessair | 0:f269e3021894 | 285 | virtual ble_error_t write(GattClient::WriteOp_t cmd, |
| elessair | 0:f269e3021894 | 286 | Gap::Handle_t connHandle, |
| elessair | 0:f269e3021894 | 287 | GattAttribute::Handle_t attributeHandle, |
| elessair | 0:f269e3021894 | 288 | size_t length, |
| elessair | 0:f269e3021894 | 289 | const uint8_t *value) const { |
| elessair | 0:f269e3021894 | 290 | /* Avoid compiler warnings about unused variables. */ |
| elessair | 0:f269e3021894 | 291 | (void)cmd; |
| elessair | 0:f269e3021894 | 292 | (void)connHandle; |
| elessair | 0:f269e3021894 | 293 | (void)attributeHandle; |
| elessair | 0:f269e3021894 | 294 | (void)length; |
| elessair | 0:f269e3021894 | 295 | (void)value; |
| elessair | 0:f269e3021894 | 296 | |
| elessair | 0:f269e3021894 | 297 | return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 298 | } |
| elessair | 0:f269e3021894 | 299 | |
| elessair | 0:f269e3021894 | 300 | /* Event callback handlers. */ |
| elessair | 0:f269e3021894 | 301 | public: |
| elessair | 0:f269e3021894 | 302 | /** |
| elessair | 0:f269e3021894 | 303 | * Set up a callback for read response events. |
| elessair | 0:f269e3021894 | 304 | * |
| elessair | 0:f269e3021894 | 305 | * @param[in] callback |
| elessair | 0:f269e3021894 | 306 | * Event handler being registered. |
| elessair | 0:f269e3021894 | 307 | * |
| elessair | 0:f269e3021894 | 308 | * @note It is possible to chain together multiple onDataRead callbacks |
| elessair | 0:f269e3021894 | 309 | * (potentially from different modules of an application). |
| elessair | 0:f269e3021894 | 310 | * |
| elessair | 0:f269e3021894 | 311 | * @note It is possible to unregister a callback using |
| elessair | 0:f269e3021894 | 312 | * onDataRead().detach(callbackToRemove). |
| elessair | 0:f269e3021894 | 313 | */ |
| elessair | 0:f269e3021894 | 314 | void onDataRead(ReadCallback_t callback) { |
| elessair | 0:f269e3021894 | 315 | onDataReadCallbackChain.add(callback); |
| elessair | 0:f269e3021894 | 316 | } |
| elessair | 0:f269e3021894 | 317 | |
| elessair | 0:f269e3021894 | 318 | /** |
| elessair | 0:f269e3021894 | 319 | * @brief Provide access to the callchain of read event callbacks. |
| elessair | 0:f269e3021894 | 320 | * |
| elessair | 0:f269e3021894 | 321 | * @return A reference to the read event callback chain. |
| elessair | 0:f269e3021894 | 322 | * |
| elessair | 0:f269e3021894 | 323 | * @note It is possible to register callbacks using onDataRead().add(callback). |
| elessair | 0:f269e3021894 | 324 | * |
| elessair | 0:f269e3021894 | 325 | * @note It is possible to unregister callbacks using onDataRead().detach(callback). |
| elessair | 0:f269e3021894 | 326 | */ |
| elessair | 0:f269e3021894 | 327 | ReadCallbackChain_t& onDataRead() { |
| elessair | 0:f269e3021894 | 328 | return onDataReadCallbackChain; |
| elessair | 0:f269e3021894 | 329 | } |
| elessair | 0:f269e3021894 | 330 | |
| elessair | 0:f269e3021894 | 331 | /** |
| elessair | 0:f269e3021894 | 332 | * Set up a callback for write response events. |
| elessair | 0:f269e3021894 | 333 | * |
| elessair | 0:f269e3021894 | 334 | * @param[in] callback |
| elessair | 0:f269e3021894 | 335 | * Event handler being registered. |
| elessair | 0:f269e3021894 | 336 | * |
| elessair | 0:f269e3021894 | 337 | * @note It is possible to remove registered callbacks using |
| elessair | 0:f269e3021894 | 338 | * onDataWritten().detach(callbackToRemove). |
| elessair | 0:f269e3021894 | 339 | * |
| elessair | 0:f269e3021894 | 340 | * @note Write commands (issued using writeWoResponse) don't generate a response. |
| elessair | 0:f269e3021894 | 341 | */ |
| elessair | 0:f269e3021894 | 342 | void onDataWritten(WriteCallback_t callback) { |
| elessair | 0:f269e3021894 | 343 | onDataWriteCallbackChain.add(callback); |
| elessair | 0:f269e3021894 | 344 | } |
| elessair | 0:f269e3021894 | 345 | |
| elessair | 0:f269e3021894 | 346 | /** |
| elessair | 0:f269e3021894 | 347 | * @brief Provide access to the callchain of data written callbacks. |
| elessair | 0:f269e3021894 | 348 | * |
| elessair | 0:f269e3021894 | 349 | * @return A reference to the data written callbacks chain. |
| elessair | 0:f269e3021894 | 350 | * |
| elessair | 0:f269e3021894 | 351 | * @note It is possible to register callbacks using onDataWritten().add(callback). |
| elessair | 0:f269e3021894 | 352 | * |
| elessair | 0:f269e3021894 | 353 | * @note It is possible to unregister callbacks using onDataWritten().detach(callback). |
| elessair | 0:f269e3021894 | 354 | */ |
| elessair | 0:f269e3021894 | 355 | WriteCallbackChain_t& onDataWritten() { |
| elessair | 0:f269e3021894 | 356 | return onDataWriteCallbackChain; |
| elessair | 0:f269e3021894 | 357 | } |
| elessair | 0:f269e3021894 | 358 | |
| elessair | 0:f269e3021894 | 359 | /** |
| elessair | 0:f269e3021894 | 360 | * Set up a callback for write response events. |
| elessair | 0:f269e3021894 | 361 | * |
| elessair | 0:f269e3021894 | 362 | * @param[in] callback |
| elessair | 0:f269e3021894 | 363 | * Event handler being registered. |
| elessair | 0:f269e3021894 | 364 | * |
| elessair | 0:f269e3021894 | 365 | * @note Write commands (issued using writeWoResponse) don't generate a response. |
| elessair | 0:f269e3021894 | 366 | * |
| elessair | 0:f269e3021894 | 367 | * @deprecated Please use GattServer::onDataWritten() instead. |
| elessair | 0:f269e3021894 | 368 | */ |
| elessair | 0:f269e3021894 | 369 | void onDataWrite(WriteCallback_t callback) { |
| elessair | 0:f269e3021894 | 370 | onDataWritten(callback); |
| elessair | 0:f269e3021894 | 371 | } |
| elessair | 0:f269e3021894 | 372 | |
| elessair | 0:f269e3021894 | 373 | /** |
| elessair | 0:f269e3021894 | 374 | * Set up a callback for when serviceDiscovery terminates. |
| elessair | 0:f269e3021894 | 375 | * |
| elessair | 0:f269e3021894 | 376 | * @param[in] callback |
| elessair | 0:f269e3021894 | 377 | * Event handler being registered. |
| elessair | 0:f269e3021894 | 378 | */ |
| elessair | 0:f269e3021894 | 379 | virtual void onServiceDiscoveryTermination(ServiceDiscovery::TerminationCallback_t callback) { |
| elessair | 0:f269e3021894 | 380 | (void)callback; /* Avoid compiler warnings about ununsed variables. */ |
| elessair | 0:f269e3021894 | 381 | |
| elessair | 0:f269e3021894 | 382 | /* Requesting action from porters: override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 383 | } |
| elessair | 0:f269e3021894 | 384 | |
| elessair | 0:f269e3021894 | 385 | /** |
| elessair | 0:f269e3021894 | 386 | * @brief Launch discovery of descriptors for a given characteristic. |
| elessair | 0:f269e3021894 | 387 | * |
| elessair | 0:f269e3021894 | 388 | * @details This function will discover all descriptors available for a |
| elessair | 0:f269e3021894 | 389 | * specific characteristic. |
| elessair | 0:f269e3021894 | 390 | * |
| elessair | 0:f269e3021894 | 391 | * @param[in] characteristic |
| elessair | 0:f269e3021894 | 392 | * The characteristic targeted by this discovery procedure. |
| elessair | 0:f269e3021894 | 393 | * @param[in] discoveryCallback |
| elessair | 0:f269e3021894 | 394 | * User function called each time a descriptor is found during |
| elessair | 0:f269e3021894 | 395 | * the procedure. |
| elessair | 0:f269e3021894 | 396 | * @param[in] terminationCallback |
| elessair | 0:f269e3021894 | 397 | * User provided function which will be called once the |
| elessair | 0:f269e3021894 | 398 | * discovery procedure is terminating. This will get called |
| elessair | 0:f269e3021894 | 399 | * when all the descriptors have been discovered or if an |
| elessair | 0:f269e3021894 | 400 | * error occur during the discovery procedure. |
| elessair | 0:f269e3021894 | 401 | * |
| elessair | 0:f269e3021894 | 402 | * @return |
| elessair | 0:f269e3021894 | 403 | * BLE_ERROR_NONE if characteristic descriptor discovery is launched |
| elessair | 0:f269e3021894 | 404 | * successfully; else an appropriate error. |
| elessair | 0:f269e3021894 | 405 | */ |
| elessair | 0:f269e3021894 | 406 | virtual ble_error_t discoverCharacteristicDescriptors( |
| elessair | 0:f269e3021894 | 407 | const DiscoveredCharacteristic& characteristic, |
| elessair | 0:f269e3021894 | 408 | const CharacteristicDescriptorDiscovery::DiscoveryCallback_t& discoveryCallback, |
| elessair | 0:f269e3021894 | 409 | const CharacteristicDescriptorDiscovery::TerminationCallback_t& terminationCallback) { |
| elessair | 0:f269e3021894 | 410 | (void) characteristic; |
| elessair | 0:f269e3021894 | 411 | (void) discoveryCallback; |
| elessair | 0:f269e3021894 | 412 | (void) terminationCallback; |
| elessair | 0:f269e3021894 | 413 | /* Requesting action from porter(s): override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 414 | return BLE_ERROR_NOT_IMPLEMENTED; |
| elessair | 0:f269e3021894 | 415 | } |
| elessair | 0:f269e3021894 | 416 | |
| elessair | 0:f269e3021894 | 417 | /** |
| elessair | 0:f269e3021894 | 418 | * @brief Indicate if the discovery of characteristic descriptors is active |
| elessair | 0:f269e3021894 | 419 | * for a given characteristic or not. |
| elessair | 0:f269e3021894 | 420 | * |
| elessair | 0:f269e3021894 | 421 | * @param[in] characteristic |
| elessair | 0:f269e3021894 | 422 | * The characteristic concerned by the descriptors discovery. |
| elessair | 0:f269e3021894 | 423 | * |
| elessair | 0:f269e3021894 | 424 | * @return true if a descriptors discovery is active for the characteristic |
| elessair | 0:f269e3021894 | 425 | * in input; otherwise false. |
| elessair | 0:f269e3021894 | 426 | */ |
| elessair | 0:f269e3021894 | 427 | virtual bool isCharacteristicDescriptorDiscoveryActive(const DiscoveredCharacteristic& characteristic) const |
| elessair | 0:f269e3021894 | 428 | { |
| elessair | 0:f269e3021894 | 429 | (void) characteristic; |
| elessair | 0:f269e3021894 | 430 | return false; /* Requesting action from porter(s): override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 431 | } |
| elessair | 0:f269e3021894 | 432 | |
| elessair | 0:f269e3021894 | 433 | /** |
| elessair | 0:f269e3021894 | 434 | * @brief Terminate an ongoing characteristic descriptor discovery. |
| elessair | 0:f269e3021894 | 435 | * |
| elessair | 0:f269e3021894 | 436 | * @details This should result in an invocation of the TerminationCallback if |
| elessair | 0:f269e3021894 | 437 | * the characteristic descriptor discovery is active. |
| elessair | 0:f269e3021894 | 438 | * |
| elessair | 0:f269e3021894 | 439 | * @param[in] characteristic |
| elessair | 0:f269e3021894 | 440 | * The characteristic on which the running descriptors |
| elessair | 0:f269e3021894 | 441 | * discovery should be stopped. |
| elessair | 0:f269e3021894 | 442 | */ |
| elessair | 0:f269e3021894 | 443 | virtual void terminateCharacteristicDescriptorDiscovery(const DiscoveredCharacteristic& characteristic) { |
| elessair | 0:f269e3021894 | 444 | /* Requesting action from porter(s): override this API if this capability is supported. */ |
| elessair | 0:f269e3021894 | 445 | (void) characteristic; |
| elessair | 0:f269e3021894 | 446 | } |
| elessair | 0:f269e3021894 | 447 | |
| elessair | 0:f269e3021894 | 448 | /** |
| elessair | 0:f269e3021894 | 449 | * Set up a callback for when the GATT Client receives an update event |
| elessair | 0:f269e3021894 | 450 | * corresponding to a change in the value of a characteristic on the remote |
| elessair | 0:f269e3021894 | 451 | * GATT Server. |
| elessair | 0:f269e3021894 | 452 | * |
| elessair | 0:f269e3021894 | 453 | * @note It is possible to unregister callbacks using |
| elessair | 0:f269e3021894 | 454 | * onHVX().detach(callbackToRemove). |
| elessair | 0:f269e3021894 | 455 | */ |
| elessair | 0:f269e3021894 | 456 | void onHVX(HVXCallback_t callback) { |
| elessair | 0:f269e3021894 | 457 | onHVXCallbackChain.add(callback); |
| elessair | 0:f269e3021894 | 458 | } |
| elessair | 0:f269e3021894 | 459 | |
| elessair | 0:f269e3021894 | 460 | /** |
| elessair | 0:f269e3021894 | 461 | * Setup a callback to be invoked to notify the user application that the |
| elessair | 0:f269e3021894 | 462 | * GattClient instance is about to shutdown (possibly as a result of a call |
| elessair | 0:f269e3021894 | 463 | * to BLE::shutdown()). |
| elessair | 0:f269e3021894 | 464 | * |
| elessair | 0:f269e3021894 | 465 | * @param[in] callback |
| elessair | 0:f269e3021894 | 466 | * Event handler being registered. |
| elessair | 0:f269e3021894 | 467 | * |
| elessair | 0:f269e3021894 | 468 | * @note It is possible to chain together multiple onShutdown callbacks |
| elessair | 0:f269e3021894 | 469 | * (potentially from different modules of an application) to be notified |
| elessair | 0:f269e3021894 | 470 | * before the GattClient is shutdown. |
| elessair | 0:f269e3021894 | 471 | * |
| elessair | 0:f269e3021894 | 472 | * @note It is also possible to set up a callback into a member function of |
| elessair | 0:f269e3021894 | 473 | * some object. |
| elessair | 0:f269e3021894 | 474 | * |
| elessair | 0:f269e3021894 | 475 | * @note It is possible to unregister a callback using onShutdown().detach(callback). |
| elessair | 0:f269e3021894 | 476 | */ |
| elessair | 0:f269e3021894 | 477 | void onShutdown(const GattClientShutdownCallback_t& callback) { |
| elessair | 0:f269e3021894 | 478 | shutdownCallChain.add(callback); |
| elessair | 0:f269e3021894 | 479 | } |
| elessair | 0:f269e3021894 | 480 | |
| elessair | 0:f269e3021894 | 481 | /** |
| elessair | 0:f269e3021894 | 482 | * Same as GattClient::onShutdown(), but allows the possibility to add an object |
| elessair | 0:f269e3021894 | 483 | * reference and member function as handler for shutdown event |
| elessair | 0:f269e3021894 | 484 | * callbacks. |
| elessair | 0:f269e3021894 | 485 | * |
| elessair | 0:f269e3021894 | 486 | * @param[in] objPtr |
| elessair | 0:f269e3021894 | 487 | * Pointer to the object of a class defining the member callback |
| elessair | 0:f269e3021894 | 488 | * function (@p memberPtr). |
| elessair | 0:f269e3021894 | 489 | * @param[in] memberPtr |
| elessair | 0:f269e3021894 | 490 | * The member callback (within the context of an object) to be |
| elessair | 0:f269e3021894 | 491 | * invoked. |
| elessair | 0:f269e3021894 | 492 | */ |
| elessair | 0:f269e3021894 | 493 | template <typename T> |
| elessair | 0:f269e3021894 | 494 | void onShutdown(T *objPtr, void (T::*memberPtr)(const GattClient *)) { |
| elessair | 0:f269e3021894 | 495 | shutdownCallChain.add(objPtr, memberPtr); |
| elessair | 0:f269e3021894 | 496 | } |
| elessair | 0:f269e3021894 | 497 | |
| elessair | 0:f269e3021894 | 498 | /** |
| elessair | 0:f269e3021894 | 499 | * @brief Provide access to the callchain of shutdown event callbacks. |
| elessair | 0:f269e3021894 | 500 | * |
| elessair | 0:f269e3021894 | 501 | * @return A reference to the shutdown event callbacks chain. |
| elessair | 0:f269e3021894 | 502 | * |
| elessair | 0:f269e3021894 | 503 | * @note It is possible to register callbacks using onShutdown().add(callback). |
| elessair | 0:f269e3021894 | 504 | * |
| elessair | 0:f269e3021894 | 505 | * @note It is possible to unregister callbacks using onShutdown().detach(callback). |
| elessair | 0:f269e3021894 | 506 | */ |
| elessair | 0:f269e3021894 | 507 | GattClientShutdownCallbackChain_t& onShutdown() { |
| elessair | 0:f269e3021894 | 508 | return shutdownCallChain; |
| elessair | 0:f269e3021894 | 509 | } |
| elessair | 0:f269e3021894 | 510 | |
| elessair | 0:f269e3021894 | 511 | /** |
| elessair | 0:f269e3021894 | 512 | * @brief provide access to the callchain of HVX callbacks. |
| elessair | 0:f269e3021894 | 513 | * |
| elessair | 0:f269e3021894 | 514 | * @return A reference to the HVX callbacks chain. |
| elessair | 0:f269e3021894 | 515 | * |
| elessair | 0:f269e3021894 | 516 | * @note It is possible to register callbacks using onHVX().add(callback). |
| elessair | 0:f269e3021894 | 517 | * |
| elessair | 0:f269e3021894 | 518 | * @note It is possible to unregister callbacks using onHVX().detach(callback). |
| elessair | 0:f269e3021894 | 519 | */ |
| elessair | 0:f269e3021894 | 520 | HVXCallbackChain_t& onHVX() { |
| elessair | 0:f269e3021894 | 521 | return onHVXCallbackChain; |
| elessair | 0:f269e3021894 | 522 | } |
| elessair | 0:f269e3021894 | 523 | |
| elessair | 0:f269e3021894 | 524 | public: |
| elessair | 0:f269e3021894 | 525 | /** |
| elessair | 0:f269e3021894 | 526 | * Notify all registered onShutdown callbacks that the GattClient is |
| elessair | 0:f269e3021894 | 527 | * about to be shutdown and clear all GattClient state of the |
| elessair | 0:f269e3021894 | 528 | * associated object. |
| elessair | 0:f269e3021894 | 529 | * |
| elessair | 0:f269e3021894 | 530 | * This function is meant to be overridden in the platform-specific |
| elessair | 0:f269e3021894 | 531 | * sub-class. Nevertheless, the sub-class is only expected to reset its |
| elessair | 0:f269e3021894 | 532 | * state and not the data held in GattClient members. This shall be achieved |
| elessair | 0:f269e3021894 | 533 | * by a call to GattClient::reset() from the sub-class' reset() |
| elessair | 0:f269e3021894 | 534 | * implementation. |
| elessair | 0:f269e3021894 | 535 | * |
| elessair | 0:f269e3021894 | 536 | * @return BLE_ERROR_NONE on success. |
| elessair | 0:f269e3021894 | 537 | */ |
| elessair | 0:f269e3021894 | 538 | virtual ble_error_t reset(void) { |
| elessair | 0:f269e3021894 | 539 | /* Notify that the instance is about to shutdown */ |
| elessair | 0:f269e3021894 | 540 | shutdownCallChain.call(this); |
| elessair | 0:f269e3021894 | 541 | shutdownCallChain.clear(); |
| elessair | 0:f269e3021894 | 542 | |
| elessair | 0:f269e3021894 | 543 | onDataReadCallbackChain.clear(); |
| elessair | 0:f269e3021894 | 544 | onDataWriteCallbackChain.clear(); |
| elessair | 0:f269e3021894 | 545 | onHVXCallbackChain.clear(); |
| elessair | 0:f269e3021894 | 546 | |
| elessair | 0:f269e3021894 | 547 | return BLE_ERROR_NONE; |
| elessair | 0:f269e3021894 | 548 | } |
| elessair | 0:f269e3021894 | 549 | |
| elessair | 0:f269e3021894 | 550 | protected: |
| elessair | 0:f269e3021894 | 551 | GattClient() { |
| elessair | 0:f269e3021894 | 552 | /* Empty */ |
| elessair | 0:f269e3021894 | 553 | } |
| elessair | 0:f269e3021894 | 554 | |
| elessair | 0:f269e3021894 | 555 | /* Entry points for the underlying stack to report events back to the user. */ |
| elessair | 0:f269e3021894 | 556 | public: |
| elessair | 0:f269e3021894 | 557 | /** |
| elessair | 0:f269e3021894 | 558 | * Helper function that notifies all registered handlers of an occurrence |
| elessair | 0:f269e3021894 | 559 | * of a data read event. This function is meant to be called from the |
| elessair | 0:f269e3021894 | 560 | * BLE stack specific implementation when a data read event occurs. |
| elessair | 0:f269e3021894 | 561 | * |
| elessair | 0:f269e3021894 | 562 | * @param[in] params |
| elessair | 0:f269e3021894 | 563 | * The data read parameters passed to the registered |
| elessair | 0:f269e3021894 | 564 | * handlers. |
| elessair | 0:f269e3021894 | 565 | */ |
| elessair | 0:f269e3021894 | 566 | void processReadResponse(const GattReadCallbackParams *params) { |
| elessair | 0:f269e3021894 | 567 | onDataReadCallbackChain(params); |
| elessair | 0:f269e3021894 | 568 | } |
| elessair | 0:f269e3021894 | 569 | |
| elessair | 0:f269e3021894 | 570 | /** |
| elessair | 0:f269e3021894 | 571 | * Helper function that notifies all registered handlers of an occurrence |
| elessair | 0:f269e3021894 | 572 | * of a data written event. This function is meant to be called from the |
| elessair | 0:f269e3021894 | 573 | * BLE stack specific implementation when a data written event occurs. |
| elessair | 0:f269e3021894 | 574 | * |
| elessair | 0:f269e3021894 | 575 | * @param[in] params |
| elessair | 0:f269e3021894 | 576 | * The data written parameters passed to the registered |
| elessair | 0:f269e3021894 | 577 | * handlers. |
| elessair | 0:f269e3021894 | 578 | */ |
| elessair | 0:f269e3021894 | 579 | void processWriteResponse(const GattWriteCallbackParams *params) { |
| elessair | 0:f269e3021894 | 580 | onDataWriteCallbackChain(params); |
| elessair | 0:f269e3021894 | 581 | } |
| elessair | 0:f269e3021894 | 582 | |
| elessair | 0:f269e3021894 | 583 | /** |
| elessair | 0:f269e3021894 | 584 | * Helper function that notifies all registered handlers of an occurrence |
| elessair | 0:f269e3021894 | 585 | * of an update event. This function is meant to be called from the |
| elessair | 0:f269e3021894 | 586 | * BLE stack specific implementation when an update event occurs. |
| elessair | 0:f269e3021894 | 587 | * |
| elessair | 0:f269e3021894 | 588 | * @param[in] params |
| elessair | 0:f269e3021894 | 589 | * The update event parameters passed to the registered |
| elessair | 0:f269e3021894 | 590 | * handlers. |
| elessair | 0:f269e3021894 | 591 | */ |
| elessair | 0:f269e3021894 | 592 | void processHVXEvent(const GattHVXCallbackParams *params) { |
| elessair | 0:f269e3021894 | 593 | if (onHVXCallbackChain) { |
| elessair | 0:f269e3021894 | 594 | onHVXCallbackChain(params); |
| elessair | 0:f269e3021894 | 595 | } |
| elessair | 0:f269e3021894 | 596 | } |
| elessair | 0:f269e3021894 | 597 | |
| elessair | 0:f269e3021894 | 598 | protected: |
| elessair | 0:f269e3021894 | 599 | /** |
| elessair | 0:f269e3021894 | 600 | * Callchain containing all registered callback handlers for data read |
| elessair | 0:f269e3021894 | 601 | * events. |
| elessair | 0:f269e3021894 | 602 | */ |
| elessair | 0:f269e3021894 | 603 | ReadCallbackChain_t onDataReadCallbackChain; |
| elessair | 0:f269e3021894 | 604 | /** |
| elessair | 0:f269e3021894 | 605 | * Callchain containing all registered callback handlers for data write |
| elessair | 0:f269e3021894 | 606 | * events. |
| elessair | 0:f269e3021894 | 607 | */ |
| elessair | 0:f269e3021894 | 608 | WriteCallbackChain_t onDataWriteCallbackChain; |
| elessair | 0:f269e3021894 | 609 | /** |
| elessair | 0:f269e3021894 | 610 | * Callchain containing all registered callback handlers for update |
| elessair | 0:f269e3021894 | 611 | * events. |
| elessair | 0:f269e3021894 | 612 | */ |
| elessair | 0:f269e3021894 | 613 | HVXCallbackChain_t onHVXCallbackChain; |
| elessair | 0:f269e3021894 | 614 | /** |
| elessair | 0:f269e3021894 | 615 | * Callchain containing all registered callback handlers for shutdown |
| elessair | 0:f269e3021894 | 616 | * events. |
| elessair | 0:f269e3021894 | 617 | */ |
| elessair | 0:f269e3021894 | 618 | GattClientShutdownCallbackChain_t shutdownCallChain; |
| elessair | 0:f269e3021894 | 619 | |
| elessair | 0:f269e3021894 | 620 | private: |
| elessair | 0:f269e3021894 | 621 | /* Disallow copy and assignment. */ |
| elessair | 0:f269e3021894 | 622 | GattClient(const GattClient &); |
| elessair | 0:f269e3021894 | 623 | GattClient& operator=(const GattClient &); |
| elessair | 0:f269e3021894 | 624 | }; |
| elessair | 0:f269e3021894 | 625 | |
| elessair | 0:f269e3021894 | 626 | #endif /* ifndef __GATT_CLIENT_H__ */ |