xiao sun / BLE_API

fork BLE_API to add update adv payload API

Fork of BLE_API by Bluetooth Low Energy

ble/FunctionPointerWithContext.h@710:b2e1a2660ec2, 2015-06-19 (annotated)

Committer:
rgrover1
Date:
Fri Jun 19 15:53:28 2015 +0100
Revision:
710:b2e1a2660ec2
Synchronized with git rev 7e8977d8

Author: Rohit Grover

Release 0.3.8

=============



This is a minor set of enhancements before we yotta-ize BLE_API.



Enhancements

~~~~~~~~~~~~



* Minor rework for class UUID; added a default and copy constructor; and a != operator.



* Added copy constructor and accessors for GapAdvertisingParams.



* GapScanningParams:: remove unnecessary checks for SCAN_TIMEOUT_MAX.



* Add a comment header block to explain why BLEDevice::init() may not be safe

  to call from global static context.



* Introduce GattAttribute::INVALID_HANDLE.



* Replace some deprecated uses of Gap::address_t with Gap::Address_t.



Bugfixes

~~~~~~~~



* None.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rgrover1 710:b2e1a2660ec2 1 /* mbed Microcontroller Library
rgrover1 710:b2e1a2660ec2 2 * Copyright (c) 2006-2013 ARM Limited
rgrover1 710:b2e1a2660ec2 3 *
rgrover1 710:b2e1a2660ec2 4 * Licensed under the Apache License, Version 2.0 (the "License");
rgrover1 710:b2e1a2660ec2 5 * you may not use this file except in compliance with the License.
rgrover1 710:b2e1a2660ec2 6 * You may obtain a copy of the License at
rgrover1 710:b2e1a2660ec2 7 *
rgrover1 710:b2e1a2660ec2 8 * http://www.apache.org/licenses/LICENSE-2.0
rgrover1 710:b2e1a2660ec2 9 *
rgrover1 710:b2e1a2660ec2 10 * Unless required by applicable law or agreed to in writing, software
rgrover1 710:b2e1a2660ec2 11 * distributed under the License is distributed on an "AS IS" BASIS,
rgrover1 710:b2e1a2660ec2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rgrover1 710:b2e1a2660ec2 13 * See the License for the specific language governing permissions and
rgrover1 710:b2e1a2660ec2 14 * limitations under the License.
rgrover1 710:b2e1a2660ec2 15 */
rgrover1 710:b2e1a2660ec2 16
rgrover1 710:b2e1a2660ec2 17 #ifndef MBED_FUNCTIONPOINTER_WITH_CONTEXT_H
rgrover1 710:b2e1a2660ec2 18 #define MBED_FUNCTIONPOINTER_WITH_CONTEXT_H
rgrover1 710:b2e1a2660ec2 19
rgrover1 710:b2e1a2660ec2 20 #include <string.h>
rgrover1 710:b2e1a2660ec2 21
rgrover1 710:b2e1a2660ec2 22
rgrover1 710:b2e1a2660ec2 23 /** A class for storing and calling a pointer to a static or member void function
rgrover1 710:b2e1a2660ec2 24 * which takes a context.
rgrover1 710:b2e1a2660ec2 25 */
rgrover1 710:b2e1a2660ec2 26 template <typename ContextType>
rgrover1 710:b2e1a2660ec2 27 class FunctionPointerWithContext {
rgrover1 710:b2e1a2660ec2 28 public:
rgrover1 710:b2e1a2660ec2 29 typedef FunctionPointerWithContext<ContextType> *pFunctionPointerWithContext_t;
rgrover1 710:b2e1a2660ec2 30 typedef void (*pvoidfcontext_t)(ContextType context);
rgrover1 710:b2e1a2660ec2 31
rgrover1 710:b2e1a2660ec2 32 /** Create a FunctionPointerWithContext, attaching a static function
rgrover1 710:b2e1a2660ec2 33 *
rgrover1 710:b2e1a2660ec2 34 * @param function The void static function to attach (default is none)
rgrover1 710:b2e1a2660ec2 35 */
rgrover1 710:b2e1a2660ec2 36 FunctionPointerWithContext(void (*function)(ContextType context) = NULL) :
rgrover1 710:b2e1a2660ec2 37 _function(NULL), _object(NULL), _member(), _membercaller(NULL), _next(NULL) {
rgrover1 710:b2e1a2660ec2 38 attach(function);
rgrover1 710:b2e1a2660ec2 39 }
rgrover1 710:b2e1a2660ec2 40
rgrover1 710:b2e1a2660ec2 41 /** Create a FunctionPointerWithContext, attaching a member function
rgrover1 710:b2e1a2660ec2 42 *
rgrover1 710:b2e1a2660ec2 43 * @param object The object pointer to invoke the member function on (i.e. the this pointer)
rgrover1 710:b2e1a2660ec2 44 * @param function The address of the void member function to attach
rgrover1 710:b2e1a2660ec2 45 */
rgrover1 710:b2e1a2660ec2 46 template<typename T>
rgrover1 710:b2e1a2660ec2 47 FunctionPointerWithContext(T *object, void (T::*member)(ContextType context)) :
rgrover1 710:b2e1a2660ec2 48 _function(NULL), _object(NULL), _member(), _membercaller(NULL), _next(NULL) {
rgrover1 710:b2e1a2660ec2 49 attach(object, member);
rgrover1 710:b2e1a2660ec2 50 }
rgrover1 710:b2e1a2660ec2 51
rgrover1 710:b2e1a2660ec2 52 /** Attach a static function
rgrover1 710:b2e1a2660ec2 53 *
rgrover1 710:b2e1a2660ec2 54 * @param function The void static function to attach (default is none)
rgrover1 710:b2e1a2660ec2 55 */
rgrover1 710:b2e1a2660ec2 56 void attach(void (*function)(ContextType context) = NULL) {
rgrover1 710:b2e1a2660ec2 57 _function = function;
rgrover1 710:b2e1a2660ec2 58 }
rgrover1 710:b2e1a2660ec2 59
rgrover1 710:b2e1a2660ec2 60 /** Attach a member function
rgrover1 710:b2e1a2660ec2 61 *
rgrover1 710:b2e1a2660ec2 62 * @param object The object pointer to invoke the member function on (i.e. the this pointer)
rgrover1 710:b2e1a2660ec2 63 * @param function The address of the void member function to attach
rgrover1 710:b2e1a2660ec2 64 */
rgrover1 710:b2e1a2660ec2 65 template<typename T>
rgrover1 710:b2e1a2660ec2 66 void attach(T *object, void (T::*member)(ContextType context)) {
rgrover1 710:b2e1a2660ec2 67 _object = static_cast<void *>(object);
rgrover1 710:b2e1a2660ec2 68 memcpy(_member, (char *)&member, sizeof(member));
rgrover1 710:b2e1a2660ec2 69 _membercaller = &FunctionPointerWithContext::membercaller<T>;
rgrover1 710:b2e1a2660ec2 70 }
rgrover1 710:b2e1a2660ec2 71
rgrover1 710:b2e1a2660ec2 72 /** Call the attached static or member function; and if there are chained
rgrover1 710:b2e1a2660ec2 73 * FunctionPointers their callbacks are invoked as well.
rgrover1 710:b2e1a2660ec2 74 * @Note: all chained callbacks stack up; so hopefully there won't be too
rgrover1 710:b2e1a2660ec2 75 * many FunctionPointers in a chain. */
rgrover1 710:b2e1a2660ec2 76 void call(ContextType context) {
rgrover1 710:b2e1a2660ec2 77 if (_function) {
rgrover1 710:b2e1a2660ec2 78 _function(context);
rgrover1 710:b2e1a2660ec2 79 } else if (_object && _membercaller) {
rgrover1 710:b2e1a2660ec2 80 _membercaller(_object, _member, context);
rgrover1 710:b2e1a2660ec2 81 }
rgrover1 710:b2e1a2660ec2 82
rgrover1 710:b2e1a2660ec2 83 /* Propagate the call to next in the chain. */
rgrover1 710:b2e1a2660ec2 84 if (_next) {
rgrover1 710:b2e1a2660ec2 85 _next->call(context);
rgrover1 710:b2e1a2660ec2 86 }
rgrover1 710:b2e1a2660ec2 87 }
rgrover1 710:b2e1a2660ec2 88
rgrover1 710:b2e1a2660ec2 89 /**
rgrover1 710:b2e1a2660ec2 90 * Setup an external FunctionPointer as a next in the chain of related
rgrover1 710:b2e1a2660ec2 91 * callbacks. Invoking call() on the head FunctionPointer will invoke all
rgrover1 710:b2e1a2660ec2 92 * chained callbacks.
rgrover1 710:b2e1a2660ec2 93 *
rgrover1 710:b2e1a2660ec2 94 * Refer to 'CallChain' as an alternative.
rgrover1 710:b2e1a2660ec2 95 */
rgrover1 710:b2e1a2660ec2 96 void chainAsNext(pFunctionPointerWithContext_t next) {
rgrover1 710:b2e1a2660ec2 97 _next = next;
rgrover1 710:b2e1a2660ec2 98 }
rgrover1 710:b2e1a2660ec2 99
rgrover1 710:b2e1a2660ec2 100 pFunctionPointerWithContext_t getNext(void) const {
rgrover1 710:b2e1a2660ec2 101 return _next;
rgrover1 710:b2e1a2660ec2 102 }
rgrover1 710:b2e1a2660ec2 103
rgrover1 710:b2e1a2660ec2 104 pvoidfcontext_t get_function() const {
rgrover1 710:b2e1a2660ec2 105 return (pvoidfcontext_t)_function;
rgrover1 710:b2e1a2660ec2 106 }
rgrover1 710:b2e1a2660ec2 107
rgrover1 710:b2e1a2660ec2 108 private:
rgrover1 710:b2e1a2660ec2 109 template<typename T>
rgrover1 710:b2e1a2660ec2 110 static void membercaller(void *object, char *member, ContextType context) {
rgrover1 710:b2e1a2660ec2 111 T *o = static_cast<T *>(object);
rgrover1 710:b2e1a2660ec2 112 void (T::*m)(ContextType);
rgrover1 710:b2e1a2660ec2 113 memcpy((char *)&m, member, sizeof(m));
rgrover1 710:b2e1a2660ec2 114 (o->*m)(context);
rgrover1 710:b2e1a2660ec2 115 }
rgrover1 710:b2e1a2660ec2 116
rgrover1 710:b2e1a2660ec2 117 void (*_function)(ContextType context); /**< static function pointer - NULL if none attached */
rgrover1 710:b2e1a2660ec2 118 void *_object; /**< object this pointer - NULL if none attached */
rgrover1 710:b2e1a2660ec2 119 char _member[16]; /**< raw member function pointer storage - converted back by
rgrover1 710:b2e1a2660ec2 120 * registered _membercaller */
rgrover1 710:b2e1a2660ec2 121 void (*_membercaller)(void *, char *, ContextType); /**< registered membercaller function to convert back and call
rgrover1 710:b2e1a2660ec2 122 * _member on _object passing the context. */
rgrover1 710:b2e1a2660ec2 123 pFunctionPointerWithContext_t _next; /**< Optional link to make a chain out of functionPointers; this
rgrover1 710:b2e1a2660ec2 124 * allows chaining function pointers without requiring
rgrover1 710:b2e1a2660ec2 125 * external memory to manage the chain. Also refer to
rgrover1 710:b2e1a2660ec2 126 * 'CallChain' as an alternative. */
rgrover1 710:b2e1a2660ec2 127 };
rgrover1 710:b2e1a2660ec2 128
rgrover1 710:b2e1a2660ec2 129 #endif // ifndef MBED_FUNCTIONPOINTER_WITH_CONTEXT_H