Jörg Küfen / BLE_API

fka mod

Fork of BLE_API by Bluetooth Low Energy

ble/GattServerEvents.h@1166:5f89f53f3f7b, 2016-04-06 (annotated)

Committer:
vcoubard
Date:
Wed Apr 06 19:15:06 2016 +0100
Revision:
1166:5f89f53f3f7b
Parent:
1048:efb29faf12fc
Child:
1179:4ab722f8dca0
Synchronized with git rev 2d88bb4c

Author: Andres Amaya Garcia

Add missing docs and fix doxy warnings in GattServerEvents.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 1166:5f89f53f3f7b 1 /* mbed Microcontroller Library
vcoubard 1166:5f89f53f3f7b 2 * Copyright (c) 2006-2013 ARM Limited
vcoubard 1166:5f89f53f3f7b 3 *
vcoubard 1166:5f89f53f3f7b 4 * Licensed under the Apache License, Version 2.0 (the "License");
vcoubard 1166:5f89f53f3f7b 5 * you may not use this file except in compliance with the License.
vcoubard 1166:5f89f53f3f7b 6 * You may obtain a copy of the License at
vcoubard 1166:5f89f53f3f7b 7 *
vcoubard 1166:5f89f53f3f7b 8 * http://www.apache.org/licenses/LICENSE-2.0
vcoubard 1166:5f89f53f3f7b 9 *
vcoubard 1166:5f89f53f3f7b 10 * Unless required by applicable law or agreed to in writing, software
vcoubard 1166:5f89f53f3f7b 11 * distributed under the License is distributed on an "AS IS" BASIS,
vcoubard 1166:5f89f53f3f7b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vcoubard 1166:5f89f53f3f7b 13 * See the License for the specific language governing permissions and
vcoubard 1166:5f89f53f3f7b 14 * limitations under the License.
vcoubard 1166:5f89f53f3f7b 15 */
vcoubard 1166:5f89f53f3f7b 16
vcoubard 1166:5f89f53f3f7b 17 #ifndef __GATT_SERVER_EVENTS_H__
vcoubard 1166:5f89f53f3f7b 18 #define __GATT_SERVER_EVENTS_H__
vcoubard 1166:5f89f53f3f7b 19
vcoubard 1166:5f89f53f3f7b 20 /**
vcoubard 1166:5f89f53f3f7b 21 * @brief The base class used to abstract away the callback events that can be
vcoubard 1166:5f89f53f3f7b 22 * triggered with the GATT Server.
vcoubard 1166:5f89f53f3f7b 23 */
vcoubard 1166:5f89f53f3f7b 24 class GattServerEvents
vcoubard 1166:5f89f53f3f7b 25 {
vcoubard 1166:5f89f53f3f7b 26 public:
vcoubard 1166:5f89f53f3f7b 27 /**
vcoubard 1166:5f89f53f3f7b 28 * Enumeration for GattServer events.
vcoubard 1166:5f89f53f3f7b 29 */
vcoubard 1166:5f89f53f3f7b 30 typedef enum gattEvent_e {
vcoubard 1166:5f89f53f3f7b 31 GATT_EVENT_DATA_SENT = 1, /**< Fired when a message was successfully sent out (notify only?) */
vcoubard 1166:5f89f53f3f7b 32 GATT_EVENT_DATA_WRITTEN = 2, /**< Client wrote data to the server (separate into char and descriptor writes?) */
vcoubard 1166:5f89f53f3f7b 33 GATT_EVENT_UPDATES_ENABLED = 3, /**< Notify/Indicate enabled in CCCD. */
vcoubard 1166:5f89f53f3f7b 34 GATT_EVENT_UPDATES_DISABLED = 4, /**< Notify/Indicate disabled in CCCD. */
vcoubard 1166:5f89f53f3f7b 35 GATT_EVENT_CONFIRMATION_RECEIVED = 5, /**< Response received from Indicate message. */
vcoubard 1166:5f89f53f3f7b 36 GATT_EVENT_READ_AUTHORIZATION_REQ = 6, /**< Request application to authorize read. */
vcoubard 1166:5f89f53f3f7b 37 GATT_EVENT_WRITE_AUTHORIZATION_REQ = 7, /**< Request application to authorize write. */
vcoubard 1166:5f89f53f3f7b 38 } gattEvent_t;
vcoubard 1166:5f89f53f3f7b 39 };
vcoubard 1166:5f89f53f3f7b 40
vcoubard 1166:5f89f53f3f7b 41 #endif /* ifndef __GATT_SERVER_EVENTS_H__ */