Microbug / 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

hw/Gap.h@30:9614522cf932, 2014-01-17 (annotated)

Committer:
ktownsend
Date:
Fri Jan 17 14:25:29 2014 +0000
Revision:
30:9614522cf932
Parent:
29:011e95ce78b8
Child:
31:2c94f0501807
Added Gap and GattServer event definitions

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ktownsend 29:011e95ce78b8 1 /* mbed Microcontroller Library
ktownsend 29:011e95ce78b8 2 * Copyright (c) 2006-2013 ARM Limited
ktownsend 29:011e95ce78b8 3 *
ktownsend 29:011e95ce78b8 4 * Licensed under the Apache License, Version 2.0 (the "License");
ktownsend 29:011e95ce78b8 5 * you may not use this file except in compliance with the License.
ktownsend 29:011e95ce78b8 6 * You may obtain a copy of the License at
ktownsend 29:011e95ce78b8 7 *
ktownsend 29:011e95ce78b8 8 * http://www.apache.org/licenses/LICENSE-2.0
ktownsend 29:011e95ce78b8 9 *
ktownsend 29:011e95ce78b8 10 * Unless required by applicable law or agreed to in writing, software
ktownsend 29:011e95ce78b8 11 * distributed under the License is distributed on an "AS IS" BASIS,
ktownsend 29:011e95ce78b8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ktownsend 29:011e95ce78b8 13 * See the License for the specific language governing permissions and
ktownsend 29:011e95ce78b8 14 * limitations under the License.
ktownsend 29:011e95ce78b8 15 */
ktownsend 29:011e95ce78b8 16
ktownsend 29:011e95ce78b8 17 #ifndef __GAP_H__
ktownsend 29:011e95ce78b8 18 #define __GAP_H__
ktownsend 29:011e95ce78b8 19
ktownsend 29:011e95ce78b8 20 #include "mbed.h"
ktownsend 29:011e95ce78b8 21 #include "blecommon.h"
ktownsend 29:011e95ce78b8 22 #include "GapAdvertisingData.h"
ktownsend 29:011e95ce78b8 23 #include "GapAdvertisingParams.h"
ktownsend 29:011e95ce78b8 24
ktownsend 29:011e95ce78b8 25 /**************************************************************************/
ktownsend 29:011e95ce78b8 26 /*!
ktownsend 29:011e95ce78b8 27 \brief
ktownsend 29:011e95ce78b8 28 The base class used to abstract GAP functionality to a specific radio
ktownsend 29:011e95ce78b8 29 transceiver, SOC or BLE Stack.
ktownsend 29:011e95ce78b8 30 */
ktownsend 29:011e95ce78b8 31 /**************************************************************************/
ktownsend 29:011e95ce78b8 32 class Gap
ktownsend 29:011e95ce78b8 33 {
ktownsend 29:011e95ce78b8 34 protected:
ktownsend 29:011e95ce78b8 35 FunctionPointer m_callback_event;
ktownsend 29:011e95ce78b8 36
ktownsend 29:011e95ce78b8 37 public:
ktownsend 29:011e95ce78b8 38 /******************************************************************/
ktownsend 29:011e95ce78b8 39 /*!
ktownsend 29:011e95ce78b8 40 \brief
ktownsend 29:011e95ce78b8 41 Identifies GAP events generated by the radio HW when an event
ktownsend 29:011e95ce78b8 42 callback occurs
ktownsend 29:011e95ce78b8 43 */
ktownsend 29:011e95ce78b8 44 /******************************************************************/
ktownsend 29:011e95ce78b8 45 typedef enum gap_event_e
ktownsend 29:011e95ce78b8 46 {
ktownsend 30:9614522cf932 47 GAP_EVENT_ADVERTISING_STARTED = 1,
ktownsend 30:9614522cf932 48 GAP_EVENT_CONNECTED = 2,
ktownsend 30:9614522cf932 49 GAP_EVENT_DISCONNECTED = 3
ktownsend 29:011e95ce78b8 50 } gapEvent_t;
ktownsend 29:011e95ce78b8 51
ktownsend 29:011e95ce78b8 52 /* These functions must be defined in the sub-class */
ktownsend 29:011e95ce78b8 53 virtual ble_error_t setAdvertising(GapAdvertisingParams &, GapAdvertisingData &, GapAdvertisingData &) = 0;
ktownsend 29:011e95ce78b8 54 virtual ble_error_t startAdvertising(void) = 0;
ktownsend 29:011e95ce78b8 55 virtual ble_error_t stopAdvertising(void) = 0;
ktownsend 29:011e95ce78b8 56
ktownsend 30:9614522cf932 57 uint16_t state; /* Initialising, Advertising, Scanning, Connected, etc. ... more than one bit can be set at a time! */
ktownsend 29:011e95ce78b8 58
ktownsend 29:011e95ce78b8 59 /* Event callback */
ktownsend 29:011e95ce78b8 60 void attach(void (*function)(void)) {
ktownsend 29:011e95ce78b8 61 m_callback_event.attach( function );
ktownsend 29:011e95ce78b8 62 }
ktownsend 29:011e95ce78b8 63
ktownsend 29:011e95ce78b8 64 template<typename T>
ktownsend 29:011e95ce78b8 65 void attach(T *object, void (T::*member)(void)) {
ktownsend 29:011e95ce78b8 66 m_callback_event.attach( object, member );
ktownsend 29:011e95ce78b8 67 }
ktownsend 29:011e95ce78b8 68 };
ktownsend 29:011e95ce78b8 69
ktownsend 29:011e95ce78b8 70 #endif