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@511:39612adfbf68, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:52:04 2015 +0100
Revision:
511:39612adfbf68
Parent:
510:fc2a15248577 
Synchronized with git rev c01f76cf

Author: Rohit Grover

cleanup around GattCallbackParamTypes

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 511:39612adfbf68 17 #ifndef __GATT_CALLBACK_PARAM_TYPES_H__
rgrover1 511:39612adfbf68 18 #define __GATT_CALLBACK_PARAM_TYPES_H__
rgrover1 265:eea11cfb6753 19
rgrover1 511:39612adfbf68 20 struct GattWriteCallbackParams {
rgrover1 511:39612adfbf68 21 enum WriteOp_t {
rgrover1 511:39612adfbf68 22 OP_INVALID = 0x00, /**< Invalid Operation. */
rgrover1 511:39612adfbf68 23 OP_WRITE_REQ = 0x01, /**< Write Request. */
rgrover1 511:39612adfbf68 24 OP_WRITE_CMD = 0x02, /**< Write Command. */
rgrover1 511:39612adfbf68 25 OP_SIGN_WRITE_CMD = 0x03, /**< Signed Write Command. */
rgrover1 511:39612adfbf68 26 OP_PREP_WRITE_REQ = 0x04, /**< Prepare Write Request. */
rgrover1 511:39612adfbf68 27 OP_EXEC_WRITE_REQ_CANCEL = 0x05, /**< Execute Write Request: Cancel all prepared writes. */
rgrover1 511:39612adfbf68 28 OP_EXEC_WRITE_REQ_NOW = 0x06, /**< Execute Write Request: Immediately execute all prepared writes. */
rgrover1 511:39612adfbf68 29 };
rgrover1 511:39612adfbf68 30
rgrover1 511:39612adfbf68 31 GattAttribute::Handle_t handle;
rgrover1 511:39612adfbf68 32 WriteOp_t writeOp; /**< Type of write operation, */
rgrover1 511:39612adfbf68 33 uint16_t offset; /**< Offset for the write operation. */
rgrover1 511:39612adfbf68 34 uint16_t len;
rgrover1 511:39612adfbf68 35 const uint8_t *data; /* @note: data might not persist beyond the callback; make a local copy if needed. */
rgrover1 265:eea11cfb6753 36 };
rgrover1 265:eea11cfb6753 37
rgrover1 511:39612adfbf68 38 struct GattReadCallbackParams {
rgrover1 511:39612adfbf68 39 GattAttribute::Handle_t handle;
rgrover1 511:39612adfbf68 40 uint16_t offset; /**< Offset for the read operation. */
rgrover1 510:fc2a15248577 41 uint16_t len;
rgrover1 511:39612adfbf68 42 const uint8_t *data; /* @note: data might not persist beyond the callback; make a local copy if needed. */
rgrover1 301:d9a39f759a6a 43 };
rgrover1 301:d9a39f759a6a 44
rgrover1 511:39612adfbf68 45 enum GattAuthCallbackReply_t {
rgrover1 326:501ad8b8bbe5 46 AUTH_CALLBACK_REPLY_SUCCESS = 0x00, /**< Success. */
rgrover1 326:501ad8b8bbe5 47 AUTH_CALLBACK_REPLY_ATTERR_INVALID_HANDLE = 0x0101, /**< ATT Error: Invalid Attribute Handle. */
rgrover1 326:501ad8b8bbe5 48 AUTH_CALLBACK_REPLY_ATTERR_READ_NOT_PERMITTED = 0x0102, /**< ATT Error: Read not permitted. */
rgrover1 326:501ad8b8bbe5 49 AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED = 0x0103, /**< ATT Error: Write not permitted. */
rgrover1 326:501ad8b8bbe5 50 AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHENTICATION = 0x0105, /**< ATT Error: Authenticated link required. */
rgrover1 326:501ad8b8bbe5 51 AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET = 0x0107, /**< ATT Error: Offset specified was past the end of the attribute. */
rgrover1 326:501ad8b8bbe5 52 AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION = 0x0108, /**< ATT Error: Used in ATT as Insufficient Authorisation. */
rgrover1 326:501ad8b8bbe5 53 AUTH_CALLBACK_REPLY_ATTERR_PREPARE_QUEUE_FULL = 0x0109, /**< ATT Error: Used in ATT as Prepare Queue Full. */
rgrover1 326:501ad8b8bbe5 54 AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_FOUND = 0x010A, /**< ATT Error: Used in ATT as Attribute not found. */
rgrover1 326:501ad8b8bbe5 55 AUTH_CALLBACK_REPLY_ATTERR_ATTRIBUTE_NOT_LONG = 0x010B, /**< ATT Error: Attribute cannot be read or written using read/write blob requests. */
rgrover1 326:501ad8b8bbe5 56 AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH = 0x010D, /**< ATT Error: Invalid value size. */
rgrover1 326:501ad8b8bbe5 57 AUTH_CALLBACK_REPLY_ATTERR_INSUF_RESOURCES = 0x0111, /**< ATT Error: Encrypted link required. */
rgrover1 326:501ad8b8bbe5 58 };
rgrover1 326:501ad8b8bbe5 59
rgrover1 511:39612adfbf68 60 struct GattWriteAuthCallbackParams {
rgrover1 511:39612adfbf68 61 GattAttribute::Handle_t handle;
rgrover1 265:eea11cfb6753 62 uint16_t offset; /**< Offset for the write operation. */
rgrover1 265:eea11cfb6753 63 uint16_t len; /**< Length of the incoming data. */
rgrover1 265:eea11cfb6753 64 const uint8_t *data; /**< Incoming data, variable length. */
rgrover1 511:39612adfbf68 65 GattAuthCallbackReply_t authorizationReply; /* This is the out parameter which needs to be set to true by the callback if the
rgrover1 511:39612adfbf68 66 * request is to proceed; false otherwise. */
rgrover1 265:eea11cfb6753 67 };
rgrover1 265:eea11cfb6753 68
rgrover1 511:39612adfbf68 69 struct GattReadAuthCallbackParams {
rgrover1 511:39612adfbf68 70 GattAttribute::Handle_t handle;
rgrover1 266:a0504765a357 71 uint16_t offset; /**< Offset for the read operation. */
rgrover1 266:a0504765a357 72 uint16_t len; /**< Optional: new length of the outgoing data. */
rgrover1 266:a0504765a357 73 uint8_t *data; /**< Optional: new outgoing data. Leave at NULL if data is unchanged. */
rgrover1 511:39612adfbf68 74 GattAuthCallbackReply_t authorizationReply; /* This is the out parameter which needs to be set to true by the callback if the
rgrover1 511:39612adfbf68 75 * request is to proceed; false otherwise. */
rgrover1 265:eea11cfb6753 76 };
rgrover1 265:eea11cfb6753 77
rgrover1 511:39612adfbf68 78 #endif /*__GATT_CALLBACK_PARAM_TYPES_H__*/