Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/platform/CallChain.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vipinranka 12:9a20164dcc47 1 /* mbed Microcontroller Library
vipinranka 12:9a20164dcc47 2 * Copyright (c) 2006-2013 ARM Limited
vipinranka 12:9a20164dcc47 3 *
vipinranka 12:9a20164dcc47 4 * Licensed under the Apache License, Version 2.0 (the "License");
vipinranka 12:9a20164dcc47 5 * you may not use this file except in compliance with the License.
vipinranka 12:9a20164dcc47 6 * You may obtain a copy of the License at
vipinranka 12:9a20164dcc47 7 *
vipinranka 12:9a20164dcc47 8 * http://www.apache.org/licenses/LICENSE-2.0
vipinranka 12:9a20164dcc47 9 *
vipinranka 12:9a20164dcc47 10 * Unless required by applicable law or agreed to in writing, software
vipinranka 12:9a20164dcc47 11 * distributed under the License is distributed on an "AS IS" BASIS,
vipinranka 12:9a20164dcc47 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vipinranka 12:9a20164dcc47 13 * See the License for the specific language governing permissions and
vipinranka 12:9a20164dcc47 14 * limitations under the License.
vipinranka 12:9a20164dcc47 15 */
vipinranka 12:9a20164dcc47 16 #ifndef MBED_CALLCHAIN_H
vipinranka 12:9a20164dcc47 17 #define MBED_CALLCHAIN_H
vipinranka 12:9a20164dcc47 18
vipinranka 12:9a20164dcc47 19 #include "platform/Callback.h"
vipinranka 12:9a20164dcc47 20 #include "platform/toolchain.h"
vipinranka 12:9a20164dcc47 21 #include <string.h>
vipinranka 12:9a20164dcc47 22
vipinranka 12:9a20164dcc47 23 namespace mbed {
vipinranka 12:9a20164dcc47 24 /** \addtogroup platform */
vipinranka 12:9a20164dcc47 25 /** @{*/
vipinranka 12:9a20164dcc47 26
vipinranka 12:9a20164dcc47 27 /** Group one or more functions in an instance of a CallChain, then call them in
vipinranka 12:9a20164dcc47 28 * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
vipinranka 12:9a20164dcc47 29 * but can be used for other purposes.
vipinranka 12:9a20164dcc47 30 *
vipinranka 12:9a20164dcc47 31 * @Note Synchronization level: Not protected
vipinranka 12:9a20164dcc47 32 *
vipinranka 12:9a20164dcc47 33 * Example:
vipinranka 12:9a20164dcc47 34 * @code
vipinranka 12:9a20164dcc47 35 * #include "mbed.h"
vipinranka 12:9a20164dcc47 36 *
vipinranka 12:9a20164dcc47 37 * CallChain chain;
vipinranka 12:9a20164dcc47 38 *
vipinranka 12:9a20164dcc47 39 * void first(void) {
vipinranka 12:9a20164dcc47 40 * printf("'first' function.\n");
vipinranka 12:9a20164dcc47 41 * }
vipinranka 12:9a20164dcc47 42 *
vipinranka 12:9a20164dcc47 43 * void second(void) {
vipinranka 12:9a20164dcc47 44 * printf("'second' function.\n");
vipinranka 12:9a20164dcc47 45 * }
vipinranka 12:9a20164dcc47 46 *
vipinranka 12:9a20164dcc47 47 * class Test {
vipinranka 12:9a20164dcc47 48 * public:
vipinranka 12:9a20164dcc47 49 * void f(void) {
vipinranka 12:9a20164dcc47 50 * printf("A::f (class member).\n");
vipinranka 12:9a20164dcc47 51 * }
vipinranka 12:9a20164dcc47 52 * };
vipinranka 12:9a20164dcc47 53 *
vipinranka 12:9a20164dcc47 54 * int main() {
vipinranka 12:9a20164dcc47 55 * Test test;
vipinranka 12:9a20164dcc47 56 *
vipinranka 12:9a20164dcc47 57 * chain.add(second);
vipinranka 12:9a20164dcc47 58 * chain.add_front(first);
vipinranka 12:9a20164dcc47 59 * chain.add(&test, &Test::f);
vipinranka 12:9a20164dcc47 60 * chain.call();
vipinranka 12:9a20164dcc47 61 * }
vipinranka 12:9a20164dcc47 62 * @endcode
vipinranka 12:9a20164dcc47 63 */
vipinranka 12:9a20164dcc47 64
vipinranka 12:9a20164dcc47 65 typedef Callback<void()> *pFunctionPointer_t;
vipinranka 12:9a20164dcc47 66 class CallChainLink;
vipinranka 12:9a20164dcc47 67
vipinranka 12:9a20164dcc47 68 class CallChain {
vipinranka 12:9a20164dcc47 69 public:
vipinranka 12:9a20164dcc47 70 /** Create an empty chain
vipinranka 12:9a20164dcc47 71 *
vipinranka 12:9a20164dcc47 72 * @param size (optional) Initial size of the chain
vipinranka 12:9a20164dcc47 73 */
vipinranka 12:9a20164dcc47 74 CallChain(int size = 4);
vipinranka 12:9a20164dcc47 75 virtual ~CallChain();
vipinranka 12:9a20164dcc47 76
vipinranka 12:9a20164dcc47 77 /** Add a function at the end of the chain
vipinranka 12:9a20164dcc47 78 *
vipinranka 12:9a20164dcc47 79 * @param func A pointer to a void function
vipinranka 12:9a20164dcc47 80 *
vipinranka 12:9a20164dcc47 81 * @returns
vipinranka 12:9a20164dcc47 82 * The function object created for 'func'
vipinranka 12:9a20164dcc47 83 */
vipinranka 12:9a20164dcc47 84 pFunctionPointer_t add(Callback<void()> func);
vipinranka 12:9a20164dcc47 85
vipinranka 12:9a20164dcc47 86 /** Add a function at the end of the chain
vipinranka 12:9a20164dcc47 87 *
vipinranka 12:9a20164dcc47 88 * @param obj pointer to the object to call the member function on
vipinranka 12:9a20164dcc47 89 * @param method pointer to the member function to be called
vipinranka 12:9a20164dcc47 90 *
vipinranka 12:9a20164dcc47 91 * @returns
vipinranka 12:9a20164dcc47 92 * The function object created for 'obj' and 'method'
vipinranka 12:9a20164dcc47 93 *
vipinranka 12:9a20164dcc47 94 * @deprecated
vipinranka 12:9a20164dcc47 95 * The add function does not support cv-qualifiers. Replaced by
vipinranka 12:9a20164dcc47 96 * add(callback(obj, method)).
vipinranka 12:9a20164dcc47 97 */
vipinranka 12:9a20164dcc47 98 template<typename T, typename M>
vipinranka 12:9a20164dcc47 99 MBED_DEPRECATED_SINCE("mbed-os-5.1",
vipinranka 12:9a20164dcc47 100 "The add function does not support cv-qualifiers. Replaced by "
vipinranka 12:9a20164dcc47 101 "add(callback(obj, method)).")
vipinranka 12:9a20164dcc47 102 pFunctionPointer_t add(T *obj, M method) {
vipinranka 12:9a20164dcc47 103 return add(callback(obj, method));
vipinranka 12:9a20164dcc47 104 }
vipinranka 12:9a20164dcc47 105
vipinranka 12:9a20164dcc47 106 /** Add a function at the beginning of the chain
vipinranka 12:9a20164dcc47 107 *
vipinranka 12:9a20164dcc47 108 * @param func A pointer to a void function
vipinranka 12:9a20164dcc47 109 *
vipinranka 12:9a20164dcc47 110 * @returns
vipinranka 12:9a20164dcc47 111 * The function object created for 'func'
vipinranka 12:9a20164dcc47 112 */
vipinranka 12:9a20164dcc47 113 pFunctionPointer_t add_front(Callback<void()> func);
vipinranka 12:9a20164dcc47 114
vipinranka 12:9a20164dcc47 115 /** Add a function at the beginning of the chain
vipinranka 12:9a20164dcc47 116 *
vipinranka 12:9a20164dcc47 117 * @param tptr pointer to the object to call the member function on
vipinranka 12:9a20164dcc47 118 * @param mptr pointer to the member function to be called
vipinranka 12:9a20164dcc47 119 *
vipinranka 12:9a20164dcc47 120 * @returns
vipinranka 12:9a20164dcc47 121 * The function object created for 'tptr' and 'mptr'
vipinranka 12:9a20164dcc47 122 *
vipinranka 12:9a20164dcc47 123 * @deprecated
vipinranka 12:9a20164dcc47 124 * The add_front function does not support cv-qualifiers. Replaced by
vipinranka 12:9a20164dcc47 125 * add_front(callback(obj, method)).
vipinranka 12:9a20164dcc47 126 */
vipinranka 12:9a20164dcc47 127 template<typename T, typename M>
vipinranka 12:9a20164dcc47 128 MBED_DEPRECATED_SINCE("mbed-os-5.1",
vipinranka 12:9a20164dcc47 129 "The add_front function does not support cv-qualifiers. Replaced by "
vipinranka 12:9a20164dcc47 130 "add_front(callback(obj, method)).")
vipinranka 12:9a20164dcc47 131 pFunctionPointer_t add_front(T *obj, M method) {
vipinranka 12:9a20164dcc47 132 return add_front(callback(obj, method));
vipinranka 12:9a20164dcc47 133 }
vipinranka 12:9a20164dcc47 134
vipinranka 12:9a20164dcc47 135 /** Get the number of functions in the chain
vipinranka 12:9a20164dcc47 136 */
vipinranka 12:9a20164dcc47 137 int size() const;
vipinranka 12:9a20164dcc47 138
vipinranka 12:9a20164dcc47 139 /** Get a function object from the chain
vipinranka 12:9a20164dcc47 140 *
vipinranka 12:9a20164dcc47 141 * @param i function object index
vipinranka 12:9a20164dcc47 142 *
vipinranka 12:9a20164dcc47 143 * @returns
vipinranka 12:9a20164dcc47 144 * The function object at position 'i' in the chain
vipinranka 12:9a20164dcc47 145 */
vipinranka 12:9a20164dcc47 146 pFunctionPointer_t get(int i) const;
vipinranka 12:9a20164dcc47 147
vipinranka 12:9a20164dcc47 148 /** Look for a function object in the call chain
vipinranka 12:9a20164dcc47 149 *
vipinranka 12:9a20164dcc47 150 * @param f the function object to search
vipinranka 12:9a20164dcc47 151 *
vipinranka 12:9a20164dcc47 152 * @returns
vipinranka 12:9a20164dcc47 153 * The index of the function object if found, -1 otherwise.
vipinranka 12:9a20164dcc47 154 */
vipinranka 12:9a20164dcc47 155 int find(pFunctionPointer_t f) const;
vipinranka 12:9a20164dcc47 156
vipinranka 12:9a20164dcc47 157 /** Clear the call chain (remove all functions in the chain).
vipinranka 12:9a20164dcc47 158 */
vipinranka 12:9a20164dcc47 159 void clear();
vipinranka 12:9a20164dcc47 160
vipinranka 12:9a20164dcc47 161 /** Remove a function object from the chain
vipinranka 12:9a20164dcc47 162 *
vipinranka 12:9a20164dcc47 163 * @arg f the function object to remove
vipinranka 12:9a20164dcc47 164 *
vipinranka 12:9a20164dcc47 165 * @returns
vipinranka 12:9a20164dcc47 166 * true if the function object was found and removed, false otherwise.
vipinranka 12:9a20164dcc47 167 */
vipinranka 12:9a20164dcc47 168 bool remove(pFunctionPointer_t f);
vipinranka 12:9a20164dcc47 169
vipinranka 12:9a20164dcc47 170 /** Call all the functions in the chain in sequence
vipinranka 12:9a20164dcc47 171 */
vipinranka 12:9a20164dcc47 172 void call();
vipinranka 12:9a20164dcc47 173
vipinranka 12:9a20164dcc47 174 void operator ()(void) {
vipinranka 12:9a20164dcc47 175 call();
vipinranka 12:9a20164dcc47 176 }
vipinranka 12:9a20164dcc47 177 pFunctionPointer_t operator [](int i) const {
vipinranka 12:9a20164dcc47 178 return get(i);
vipinranka 12:9a20164dcc47 179 }
vipinranka 12:9a20164dcc47 180
vipinranka 12:9a20164dcc47 181 /* disallow copy constructor and assignment operators */
vipinranka 12:9a20164dcc47 182 private:
vipinranka 12:9a20164dcc47 183 CallChain(const CallChain&);
vipinranka 12:9a20164dcc47 184 CallChain & operator = (const CallChain&);
vipinranka 12:9a20164dcc47 185 CallChainLink *_chain;
vipinranka 12:9a20164dcc47 186 };
vipinranka 12:9a20164dcc47 187
vipinranka 12:9a20164dcc47 188 } // namespace mbed
vipinranka 12:9a20164dcc47 189
vipinranka 12:9a20164dcc47 190 #endif
vipinranka 12:9a20164dcc47 191
vipinranka 12:9a20164dcc47 192 /** @}*/