Joshua Slater / BLE_API_Changed

Changed URIBeaconConfigService.h to work with ST board

Fork of BLE_API by Bluetooth Low Energy

public/GattCharacteristicCallbackParams.h@509:fc2a15248577, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:04 2015 +0100
Revision:
509:fc2a15248577
Parent:
507:77c551e72d06
Child:
510:39612adfbf68
Synchronized with git rev 49c495d3

Author: Rohit Grover

get rid of 'op' from GattCharacteristicReadCBParams

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 264:eea11cfb6753 1 /* mbed Microcontroller Library
rgrover1 264:eea11cfb6753 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 264:eea11cfb6753 3 *
rgrover1 264:eea11cfb6753 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 264:eea11cfb6753 5 * you may not use this file except in compliance with the License.
rgrover1 264:eea11cfb6753 6 * You may obtain a copy of the License at
rgrover1 264:eea11cfb6753 7 *
rgrover1 264:eea11cfb6753 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 264:eea11cfb6753 9 *
rgrover1 264:eea11cfb6753 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 264:eea11cfb6753 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 264:eea11cfb6753 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 264:eea11cfb6753 13 * See the License for the specific language governing permissions and
rgrover1 264:eea11cfb6753 14 * limitations under the License.
rgrover1 264:eea11cfb6753 15 */
rgrover1 264:eea11cfb6753 16
rgrover1 264:eea11cfb6753 17 #ifndef __GATT_CHARACTERISTIC_CALLBACK_PARAMS_H__
rgrover1 264:eea11cfb6753 18 #define __GATT_CHARACTERISTIC_CALLBACK_PARAMS_H__
rgrover1 264:eea11cfb6753 19
rgrover1 264:eea11cfb6753 20 struct GattCharacteristicWriteCBParams {
rgrover1 264:eea11cfb6753 21 GattAttribute::Handle_t charHandle;
rgrover1 264:eea11cfb6753 22 enum Type {
rgrover1 264:eea11cfb6753 23 GATTS_CHAR_OP_INVALID = 0x00, /**< Invalid Operation. */
rgrover1 264:eea11cfb6753 24 GATTS_CHAR_OP_WRITE_REQ = 0x01, /**< Write Request. */
rgrover1 264:eea11cfb6753 25 GATTS_CHAR_OP_WRITE_CMD = 0x02, /**< Write Command. */
rgrover1 264:eea11cfb6753 26 GATTS_CHAR_OP_SIGN_WRITE_CMD = 0x03, /**< Signed Write Command. */
rgrover1 264:eea11cfb6753 27 GATTS_CHAR_OP_PREP_WRITE_REQ = 0x04, /**< Prepare Write Request. */
rgrover1 264:eea11cfb6753 28 GATTS_CHAR_OP_EXEC_WRITE_REQ_CANCEL = 0x05, /**< Execute Write Request: Cancel all prepared writes. */
rgrover1 264:eea11cfb6753 29 GATTS_CHAR_OP_EXEC_WRITE_REQ_NOW = 0x06, /**< Execute Write Request: Immediately execute all prepared writes. */
rgrover1 507:77c551e72d06 30 } op; /**< Type of write operation, */
rgrover1 507:77c551e72d06 31 uint16_t offset; /**< Offset for the write operation. */
rgrover1 507:77c551e72d06 32 uint16_t len;
rgrover1 507:77c551e72d06 33 const uint8_t *data; /* @note: data might not persist beyond the callback; make a local copy if needed. */
rgrover1 264:eea11cfb6753 34 };
rgrover1 264:eea11cfb6753 35
rgrover1 300:d9a39f759a6a 36 struct GattCharacteristicReadCBParams {
rgrover1 509:fc2a15248577 37 GattAttribute::Handle_t charHandle;
rgrover1 509:fc2a15248577 38 uint16_t offset; /**< Offset for the read operation. */
rgrover1 509:fc2a15248577 39 uint16_t len;
rgrover1 509:fc2a15248577 40 const uint8_t *data; /* @note: data might not persist beyond the callback; make a local copy if needed. */
rgrover1 300:d9a39f759a6a 41 };
rgrover1 300:d9a39f759a6a 42
rgrover1 325:501ad8b8bbe5 43 enum GattCharacteristicAuthCBReply_t {
rgrover1 325:501ad8b8bbe5 44 AUTH_CALLBACK_REPLY_SUCCESS = 0x00, /**< Success. */
rgrover1 325:501ad8b8bbe5 45 AUTH_CALLBACK_REPLY_ATTERR_INVALID_HANDLE = 0x0101, /**< ATT Error: Invalid Attribute Handle. */
rgrover1 325:501ad8b8bbe5 46 AUTH_CALLBACK_REPLY_ATTERR_READ_NOT_PERMITTED = 0x0102, /**< ATT Error: Read not permitted. */
rgrover1 325:501ad8b8bbe5 47 AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED = 0x0103, /**< ATT Error: Write not permitted. */
rgrover1 325:501ad8b8bbe5 48 AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHENTICATION = 0x0105, /**< ATT Error: Authenticated link required. */
rgrover1 325:501ad8b8bbe5 49 AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET = 0x0107, /**< ATT Error: Offset specified was past the end of the attribute. */
rgrover1 325:501ad8b8bbe5 50 AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION = 0x0108, /**< ATT Error: Used in ATT as Insufficient Authorisation. */
rgrover1 325:501ad8b8bbe5 51 AUTH_CALLBACK_REPLY_ATTERR_PREPARE_QUEUE_FULL = 0x0109, /**< ATT Error: Used in ATT as Prepare Queue Full. */
rgrover1 325:501ad8b8bbe5 52 AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_FOUND = 0x010A, /**< ATT Error: Used in ATT as Attribute not found. */
rgrover1 325:501ad8b8bbe5 53 AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_LONG = 0x010B, /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */
rgrover1 325:501ad8b8bbe5 54 AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH = 0x010D, /**< ATT Error: Invalid value size. */
rgrover1 325:501ad8b8bbe5 55 AUTH_CALLBACK_REPLY_ATTERR_INSUF_RESOURCES = 0x0111, /**< ATT Error: Encrypted link required. */
rgrover1 325:501ad8b8bbe5 56 };
rgrover1 325:501ad8b8bbe5 57
rgrover1 264:eea11cfb6753 58 struct GattCharacteristicWriteAuthCBParams {
rgrover1 264:eea11cfb6753 59 GattAttribute::Handle_t charHandle;
rgrover1 264:eea11cfb6753 60 uint16_t offset; /**< Offset for the write operation. */
rgrover1 264:eea11cfb6753 61 uint16_t len; /**< Length of the incoming data. */
rgrover1 264:eea11cfb6753 62 const uint8_t *data; /**< Incoming data, variable length. */
rgrover1 325:501ad8b8bbe5 63 GattCharacteristicAuthCBReply_t authorizationReply; /* This is the out parameter which needs to be set to true by the callback if the
rgrover1 325:501ad8b8bbe5 64 * request is to proceed; false otherwise. */
rgrover1 264:eea11cfb6753 65 };
rgrover1 264:eea11cfb6753 66
rgrover1 264:eea11cfb6753 67 struct GattCharacteristicReadAuthCBParams {
rgrover1 264:eea11cfb6753 68 GattAttribute::Handle_t charHandle;
rgrover1 265:a0504765a357 69 uint16_t offset; /**< Offset for the read operation. */
rgrover1 265:a0504765a357 70 uint16_t len; /**< Optional: new length of the outgoing data. */
rgrover1 265:a0504765a357 71 uint8_t *data; /**< Optional: new outgoing data. Leave at NULL if data is unchanged. */
rgrover1 325:501ad8b8bbe5 72 GattCharacteristicAuthCBReply_t authorizationReply; /* This is the out parameter which needs to be set to true by the callback if the
rgrover1 325:501ad8b8bbe5 73 * request is to proceed; false otherwise. */
rgrover1 264:eea11cfb6753 74 };
rgrover1 264:eea11cfb6753 75
rgrover1 264:eea11cfb6753 76 #endif /*__GATT_CHARACTERISTIC_CALLBACK_PARAMS_H__*/