security manager conflict commented 2
Dependencies: BLE_API mbed-dev-bin nRF51822
Fork of microbit-dal by
inc/core/MicroBitListener.h@7:a4042bbb7f8b, 2016-04-07 (annotated)
- Committer:
- LancasterUniversity
- Date:
- Thu Apr 07 23:39:33 2016 +0100
- Revision:
- 7:a4042bbb7f8b
- Parent:
- 1:8aa5cdb4ab67
Synchronized with git rev b5193dbc
Author: Joe Finney
microbit: BUGFIX - missing NULL initialisation in templated MicroBitListener
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Jonathan Austin |
1:8aa5cdb4ab67 | 1 | /* |
Jonathan Austin |
1:8aa5cdb4ab67 | 2 | The MIT License (MIT) |
Jonathan Austin |
1:8aa5cdb4ab67 | 3 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 4 | Copyright (c) 2016 British Broadcasting Corporation. |
Jonathan Austin |
1:8aa5cdb4ab67 | 5 | This software is provided by Lancaster University by arrangement with the BBC. |
Jonathan Austin |
1:8aa5cdb4ab67 | 6 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 7 | Permission is hereby granted, free of charge, to any person obtaining a |
Jonathan Austin |
1:8aa5cdb4ab67 | 8 | copy of this software and associated documentation files (the "Software"), |
Jonathan Austin |
1:8aa5cdb4ab67 | 9 | to deal in the Software without restriction, including without limitation |
Jonathan Austin |
1:8aa5cdb4ab67 | 10 | the rights to use, copy, modify, merge, publish, distribute, sublicense, |
Jonathan Austin |
1:8aa5cdb4ab67 | 11 | and/or sell copies of the Software, and to permit persons to whom the |
Jonathan Austin |
1:8aa5cdb4ab67 | 12 | Software is furnished to do so, subject to the following conditions: |
Jonathan Austin |
1:8aa5cdb4ab67 | 13 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 14 | The above copyright notice and this permission notice shall be included in |
Jonathan Austin |
1:8aa5cdb4ab67 | 15 | all copies or substantial portions of the Software. |
Jonathan Austin |
1:8aa5cdb4ab67 | 16 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
Jonathan Austin |
1:8aa5cdb4ab67 | 18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
Jonathan Austin |
1:8aa5cdb4ab67 | 19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
Jonathan Austin |
1:8aa5cdb4ab67 | 20 | THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
Jonathan Austin |
1:8aa5cdb4ab67 | 21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
Jonathan Austin |
1:8aa5cdb4ab67 | 22 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
Jonathan Austin |
1:8aa5cdb4ab67 | 23 | DEALINGS IN THE SOFTWARE. |
Jonathan Austin |
1:8aa5cdb4ab67 | 24 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 25 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 26 | #ifndef MICROBIT_LISTENER_H |
Jonathan Austin |
1:8aa5cdb4ab67 | 27 | #define MICROBIT_LISTENER_H |
Jonathan Austin |
1:8aa5cdb4ab67 | 28 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 29 | #include "mbed.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 30 | #include "MicroBitConfig.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 31 | #include "MicroBitEvent.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 32 | #include "MemberFunctionCallback.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 33 | #include "MicroBitConfig.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 34 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 35 | // MicroBitListener flags... |
Jonathan Austin |
1:8aa5cdb4ab67 | 36 | #define MESSAGE_BUS_LISTENER_PARAMETERISED 0x0001 |
Jonathan Austin |
1:8aa5cdb4ab67 | 37 | #define MESSAGE_BUS_LISTENER_METHOD 0x0002 |
Jonathan Austin |
1:8aa5cdb4ab67 | 38 | #define MESSAGE_BUS_LISTENER_BUSY 0x0004 |
Jonathan Austin |
1:8aa5cdb4ab67 | 39 | #define MESSAGE_BUS_LISTENER_REENTRANT 0x0008 |
Jonathan Austin |
1:8aa5cdb4ab67 | 40 | #define MESSAGE_BUS_LISTENER_QUEUE_IF_BUSY 0x0010 |
Jonathan Austin |
1:8aa5cdb4ab67 | 41 | #define MESSAGE_BUS_LISTENER_DROP_IF_BUSY 0x0020 |
Jonathan Austin |
1:8aa5cdb4ab67 | 42 | #define MESSAGE_BUS_LISTENER_NONBLOCKING 0x0040 |
Jonathan Austin |
1:8aa5cdb4ab67 | 43 | #define MESSAGE_BUS_LISTENER_URGENT 0x0080 |
Jonathan Austin |
1:8aa5cdb4ab67 | 44 | #define MESSAGE_BUS_LISTENER_DELETING 0x8000 |
Jonathan Austin |
1:8aa5cdb4ab67 | 45 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 46 | #define MESSAGE_BUS_LISTENER_IMMEDIATE (MESSAGE_BUS_LISTENER_NONBLOCKING | MESSAGE_BUS_LISTENER_URGENT) |
Jonathan Austin |
1:8aa5cdb4ab67 | 47 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 48 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 49 | * This structure defines a MicroBitListener used to invoke functions, or member |
Jonathan Austin |
1:8aa5cdb4ab67 | 50 | * functions if an instance of EventModel receives an event whose id and value |
Jonathan Austin |
1:8aa5cdb4ab67 | 51 | * match this MicroBitListener's id and value. |
Jonathan Austin |
1:8aa5cdb4ab67 | 52 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 53 | struct MicroBitListener |
Jonathan Austin |
1:8aa5cdb4ab67 | 54 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 55 | uint16_t id; // The ID of the component that this listener is interested in. |
Jonathan Austin |
1:8aa5cdb4ab67 | 56 | uint16_t value; // Value this listener is interested in receiving. |
Jonathan Austin |
1:8aa5cdb4ab67 | 57 | uint16_t flags; // Status and configuration options codes for this listener. |
Jonathan Austin |
1:8aa5cdb4ab67 | 58 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 59 | union |
Jonathan Austin |
1:8aa5cdb4ab67 | 60 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 61 | void (*cb)(MicroBitEvent); |
Jonathan Austin |
1:8aa5cdb4ab67 | 62 | void (*cb_param)(MicroBitEvent, void *); |
Jonathan Austin |
1:8aa5cdb4ab67 | 63 | MemberFunctionCallback *cb_method; |
Jonathan Austin |
1:8aa5cdb4ab67 | 64 | }; |
Jonathan Austin |
1:8aa5cdb4ab67 | 65 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 66 | void* cb_arg; // Optional argument to be passed to the caller. |
Jonathan Austin |
1:8aa5cdb4ab67 | 67 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 68 | MicroBitEvent evt; |
Jonathan Austin |
1:8aa5cdb4ab67 | 69 | MicroBitEventQueueItem *evt_queue; |
Jonathan Austin |
1:8aa5cdb4ab67 | 70 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 71 | MicroBitListener *next; |
Jonathan Austin |
1:8aa5cdb4ab67 | 72 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 73 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 74 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 75 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 76 | * Create a new Message Bus Listener. |
Jonathan Austin |
1:8aa5cdb4ab67 | 77 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 78 | * @param id The ID of the component you want to listen to. |
Jonathan Austin |
1:8aa5cdb4ab67 | 79 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 80 | * @param value The event value you would like to listen to from that component |
Jonathan Austin |
1:8aa5cdb4ab67 | 81 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 82 | * @param handler A function pointer to call when the event is detected. |
Jonathan Austin |
1:8aa5cdb4ab67 | 83 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 84 | * @param flags User specified, implementation specific flags, that allow behaviour of this events listener |
Jonathan Austin |
1:8aa5cdb4ab67 | 85 | * to be tuned. |
Jonathan Austin |
1:8aa5cdb4ab67 | 86 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 87 | MicroBitListener(uint16_t id, uint16_t value, void (*handler)(MicroBitEvent), uint16_t flags = EVENT_LISTENER_DEFAULT_FLAGS); |
Jonathan Austin |
1:8aa5cdb4ab67 | 88 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 89 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 90 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 91 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 92 | * Create a new Message Bus Listener, this constructor accepts an additional |
Jonathan Austin |
1:8aa5cdb4ab67 | 93 | * parameter "arg", which is passed to the handler. |
Jonathan Austin |
1:8aa5cdb4ab67 | 94 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 95 | * @param id The ID of the component you want to listen to. |
Jonathan Austin |
1:8aa5cdb4ab67 | 96 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 97 | * @param value The event value you would like to listen to from that component |
Jonathan Austin |
1:8aa5cdb4ab67 | 98 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 99 | * @param handler A function pointer to call when the event is detected. |
Jonathan Austin |
1:8aa5cdb4ab67 | 100 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 101 | * @param arg A pointer to some data that will be given to the handler. |
Jonathan Austin |
1:8aa5cdb4ab67 | 102 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 103 | * @param flags User specified, implementation specific flags, that allow behaviour of this events listener |
Jonathan Austin |
1:8aa5cdb4ab67 | 104 | * to be tuned. |
Jonathan Austin |
1:8aa5cdb4ab67 | 105 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 106 | MicroBitListener(uint16_t id, uint16_t value, void (*handler)(MicroBitEvent, void *), void* arg, uint16_t flags = EVENT_LISTENER_DEFAULT_FLAGS); |
Jonathan Austin |
1:8aa5cdb4ab67 | 107 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 108 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 109 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 110 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 111 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 112 | * Create a new Message Bus Listener, with a callback to a C++ member function. |
Jonathan Austin |
1:8aa5cdb4ab67 | 113 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 114 | * @param id The ID of the component you want to listen to. |
Jonathan Austin |
1:8aa5cdb4ab67 | 115 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 116 | * @param value The event value you would like to listen to from that component |
Jonathan Austin |
1:8aa5cdb4ab67 | 117 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 118 | * @param object The C++ object on which to call the event handler. |
Jonathan Austin |
1:8aa5cdb4ab67 | 119 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 120 | * @param method The method within the C++ object to call. |
Jonathan Austin |
1:8aa5cdb4ab67 | 121 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 122 | * @param flags User specified, implementation specific flags, that allow behaviour of this events listener |
Jonathan Austin |
1:8aa5cdb4ab67 | 123 | * to be tuned. |
Jonathan Austin |
1:8aa5cdb4ab67 | 124 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 125 | template <typename T> |
Jonathan Austin |
1:8aa5cdb4ab67 | 126 | MicroBitListener(uint16_t id, uint16_t value, T* object, void (T::*method)(MicroBitEvent), uint16_t flags = EVENT_LISTENER_DEFAULT_FLAGS); |
Jonathan Austin |
1:8aa5cdb4ab67 | 127 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 128 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 129 | * Destructor. Ensures all resources used by this listener are freed. |
Jonathan Austin |
1:8aa5cdb4ab67 | 130 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 131 | ~MicroBitListener(); |
Jonathan Austin |
1:8aa5cdb4ab67 | 132 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 133 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 134 | * Queues and event up to be processed. |
Jonathan Austin |
1:8aa5cdb4ab67 | 135 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 136 | * @param e The event to queue |
Jonathan Austin |
1:8aa5cdb4ab67 | 137 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 138 | void queue(MicroBitEvent e); |
Jonathan Austin |
1:8aa5cdb4ab67 | 139 | }; |
Jonathan Austin |
1:8aa5cdb4ab67 | 140 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 141 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 142 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 143 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 144 | * Create a new Message Bus Listener, with a callback to a C++ member function. |
Jonathan Austin |
1:8aa5cdb4ab67 | 145 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 146 | * @param id The ID of the component you want to listen to. |
Jonathan Austin |
1:8aa5cdb4ab67 | 147 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 148 | * @param value The event value you would like to listen to from that component |
Jonathan Austin |
1:8aa5cdb4ab67 | 149 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 150 | * @param object The C++ object on which to call the event handler. |
Jonathan Austin |
1:8aa5cdb4ab67 | 151 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 152 | * @param method The method within the C++ object to call. |
Jonathan Austin |
1:8aa5cdb4ab67 | 153 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 154 | * @param flags User specified, implementation specific flags, that allow behaviour of this events listener |
Jonathan Austin |
1:8aa5cdb4ab67 | 155 | * to be tuned. |
Jonathan Austin |
1:8aa5cdb4ab67 | 156 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 157 | template <typename T> |
Jonathan Austin |
1:8aa5cdb4ab67 | 158 | MicroBitListener::MicroBitListener(uint16_t id, uint16_t value, T* object, void (T::*method)(MicroBitEvent), uint16_t flags) |
Jonathan Austin |
1:8aa5cdb4ab67 | 159 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 160 | this->id = id; |
Jonathan Austin |
1:8aa5cdb4ab67 | 161 | this->value = value; |
Jonathan Austin |
1:8aa5cdb4ab67 | 162 | this->cb_method = new MemberFunctionCallback(object, method); |
Jonathan Austin |
1:8aa5cdb4ab67 | 163 | this->cb_arg = NULL; |
Jonathan Austin |
1:8aa5cdb4ab67 | 164 | this->flags = flags | MESSAGE_BUS_LISTENER_METHOD; |
LancasterUniversity | 7:a4042bbb7f8b | 165 | this->evt_queue = NULL; |
Jonathan Austin |
1:8aa5cdb4ab67 | 166 | this->next = NULL; |
Jonathan Austin |
1:8aa5cdb4ab67 | 167 | } |
Jonathan Austin |
1:8aa5cdb4ab67 | 168 | |
LancasterUniversity | 7:a4042bbb7f8b | 169 | #endif |