Oscar Ariza / 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

public/GattCharacteristicCallbackParams.h@266:a0504765a357, 2015-01-21 (annotated)

Committer:
rgrover1
Date:
Wed Jan 21 09:32:50 2015 +0000
Revision:
266:a0504765a357
Parent:
265:eea11cfb6753
Child:
293:b5ee2ada4f33
Synchronized with git rev 4426616b

Author: Marcus Chang

Added optional data and length fields to the return struct for authorized reads so a new value can be provided for each individual authorization.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 265:eea11cfb6753 1 /* mbed Microcontroller Library
rgrover1 265:eea11cfb6753 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 265:eea11cfb6753 3 *
rgrover1 265:eea11cfb6753 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 265:eea11cfb6753 5 * you may not use this file except in compliance with the License.
rgrover1 265:eea11cfb6753 6 * You may obtain a copy of the License at
rgrover1 265:eea11cfb6753 7 *
rgrover1 265:eea11cfb6753 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 265:eea11cfb6753 9 *
rgrover1 265:eea11cfb6753 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 265:eea11cfb6753 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 265:eea11cfb6753 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 265:eea11cfb6753 13 * See the License for the specific language governing permissions and
rgrover1 265:eea11cfb6753 14 * limitations under the License.
rgrover1 265:eea11cfb6753 15 */
rgrover1 265:eea11cfb6753 16
rgrover1 265:eea11cfb6753 17 #ifndef __GATT_CHARACTERISTIC_CALLBACK_PARAMS_H__
rgrover1 265:eea11cfb6753 18 #define __GATT_CHARACTERISTIC_CALLBACK_PARAMS_H__
rgrover1 265:eea11cfb6753 19
rgrover1 265:eea11cfb6753 20 struct GattCharacteristicWriteCBParams {
rgrover1 265:eea11cfb6753 21 GattAttribute::Handle_t charHandle;
rgrover1 265:eea11cfb6753 22 enum Type {
rgrover1 265:eea11cfb6753 23 GATTS_CHAR_OP_INVALID = 0x00, /**< Invalid Operation. */
rgrover1 265:eea11cfb6753 24 GATTS_CHAR_OP_WRITE_REQ = 0x01, /**< Write Request. */
rgrover1 265:eea11cfb6753 25 GATTS_CHAR_OP_WRITE_CMD = 0x02, /**< Write Command. */
rgrover1 265:eea11cfb6753 26 GATTS_CHAR_OP_SIGN_WRITE_CMD = 0x03, /**< Signed Write Command. */
rgrover1 265:eea11cfb6753 27 GATTS_CHAR_OP_PREP_WRITE_REQ = 0x04, /**< Prepare Write Request. */
rgrover1 265:eea11cfb6753 28 GATTS_CHAR_OP_EXEC_WRITE_REQ_CANCEL = 0x05, /**< Execute Write Request: Cancel all prepared writes. */
rgrover1 265:eea11cfb6753 29 GATTS_CHAR_OP_EXEC_WRITE_REQ_NOW = 0x06, /**< Execute Write Request: Immediately execute all prepared writes. */
rgrover1 265:eea11cfb6753 30 } op; /**< Type of write operation, */
rgrover1 265:eea11cfb6753 31 uint16_t offset; /**< Offset for the write operation. */
rgrover1 265:eea11cfb6753 32 uint16_t len; /**< Length of the incoming data. */
rgrover1 265:eea11cfb6753 33 const uint8_t *data; /**< Incoming data, variable length. */
rgrover1 265:eea11cfb6753 34 };
rgrover1 265:eea11cfb6753 35
rgrover1 265:eea11cfb6753 36 struct GattCharacteristicWriteAuthCBParams {
rgrover1 265:eea11cfb6753 37 GattAttribute::Handle_t charHandle;
rgrover1 265:eea11cfb6753 38 uint16_t offset; /**< Offset for the write operation. */
rgrover1 265:eea11cfb6753 39 uint16_t len; /**< Length of the incoming data. */
rgrover1 265:eea11cfb6753 40 const uint8_t *data; /**< Incoming data, variable length. */
rgrover1 265:eea11cfb6753 41 bool authorizationReply; /* This is the out parameter which needs to be set to true by the callback if the
rgrover1 265:eea11cfb6753 42 * request is to proceed; false otherwise. */
rgrover1 265:eea11cfb6753 43 };
rgrover1 265:eea11cfb6753 44
rgrover1 265:eea11cfb6753 45 struct GattCharacteristicReadAuthCBParams {
rgrover1 265:eea11cfb6753 46 GattAttribute::Handle_t charHandle;
rgrover1 266:a0504765a357 47 uint16_t offset; /**< Offset for the read operation. */
rgrover1 266:a0504765a357 48 uint16_t len; /**< Optional: new length of the outgoing data. */
rgrover1 266:a0504765a357 49 uint8_t *data; /**< Optional: new outgoing data. Leave at NULL if data is unchanged. */
rgrover1 265:eea11cfb6753 50 bool authorizationReply; /* This is the out parameter which needs to be set to true by the callback if the
rgrover1 265:eea11cfb6753 51 * request is to proceed; false otherwise. */
rgrover1 265:eea11cfb6753 52 };
rgrover1 265:eea11cfb6753 53
rgrover1 265:eea11cfb6753 54 #endif /*__GATT_CHARACTERISTIC_CALLBACK_PARAMS_H__*/