Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

RPCInterface/RPCVariable.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ninoderkinderen 0:8d87bc453349 1 /**
ninoderkinderen 0:8d87bc453349 2 * @section LICENSE
ninoderkinderen 0:8d87bc453349 3 *Copyright (c) 2010 ARM Ltd.
ninoderkinderen 0:8d87bc453349 4 *
ninoderkinderen 0:8d87bc453349 5 *Permission is hereby granted, free of charge, to any person obtaining a copy
ninoderkinderen 0:8d87bc453349 6 *of this software and associated documentation files (the "Software"), to deal
ninoderkinderen 0:8d87bc453349 7 *in the Software without restriction, including without limitation the rights
ninoderkinderen 0:8d87bc453349 8 *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ninoderkinderen 0:8d87bc453349 9 *copies of the Software, and to permit persons to whom the Software is
ninoderkinderen 0:8d87bc453349 10 *furnished to do so, subject to the following conditions:
ninoderkinderen 0:8d87bc453349 11 *
ninoderkinderen 0:8d87bc453349 12 *The above copyright notice and this permission notice shall be included in
ninoderkinderen 0:8d87bc453349 13 *all copies or substantial portions of the Software.
ninoderkinderen 0:8d87bc453349 14 *
ninoderkinderen 0:8d87bc453349 15 *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ninoderkinderen 0:8d87bc453349 16 *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ninoderkinderen 0:8d87bc453349 17 *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ninoderkinderen 0:8d87bc453349 18 *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ninoderkinderen 0:8d87bc453349 19 *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ninoderkinderen 0:8d87bc453349 20 *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ninoderkinderen 0:8d87bc453349 21 *THE SOFTWARE.
ninoderkinderen 0:8d87bc453349 22 *
ninoderkinderen 0:8d87bc453349 23 * @section Description
ninoderkinderen 0:8d87bc453349 24 *This class provides an object to which a variable can be attached. Any type
ninoderkinderen 0:8d87bc453349 25 *for which a parse_args function specilisation exists can be attached. This includes
ninoderkinderen 0:8d87bc453349 26 *all of the standard types.
ninoderkinderen 0:8d87bc453349 27 *
ninoderkinderen 0:8d87bc453349 28 */
ninoderkinderen 0:8d87bc453349 29 #ifndef RPCVARIABLE_H_
ninoderkinderen 0:8d87bc453349 30 #define RPCVARIABLE_H_
ninoderkinderen 0:8d87bc453349 31
ninoderkinderen 0:8d87bc453349 32 #include "mbed.h"
ninoderkinderen 0:8d87bc453349 33 #include "platform.h"
ninoderkinderen 0:8d87bc453349 34 #include "rpc.h"
ninoderkinderen 0:8d87bc453349 35 /**
ninoderkinderen 0:8d87bc453349 36 *Class to read and set an attached variable using the RPC
ninoderkinderen 0:8d87bc453349 37 *
ninoderkinderen 0:8d87bc453349 38 */
ninoderkinderen 0:8d87bc453349 39 template<class T>
ninoderkinderen 0:8d87bc453349 40 class RPCVariable : public Base{
ninoderkinderen 0:8d87bc453349 41 public:
ninoderkinderen 0:8d87bc453349 42 /**
ninoderkinderen 0:8d87bc453349 43 * Constructor
ninoderkinderen 0:8d87bc453349 44 *
ninoderkinderen 0:8d87bc453349 45 *@param ptr Pointer to the variable to make accessible over RPC. Any type of
ninoderkinderen 0:8d87bc453349 46 *variable can be connected
ninoderkinderen 0:8d87bc453349 47 *@param name The name of that this object will be over RPC
ninoderkinderen 0:8d87bc453349 48 */
ninoderkinderen 0:8d87bc453349 49 template<class A>
ninoderkinderen 0:8d87bc453349 50 RPCVariable(A * ptr, const char * name) : Base(name){
ninoderkinderen 0:8d87bc453349 51 _ptr = ptr;
ninoderkinderen 0:8d87bc453349 52 }
ninoderkinderen 0:8d87bc453349 53 /**
ninoderkinderen 0:8d87bc453349 54 *Read the variable over RPC.
ninoderkinderen 0:8d87bc453349 55 *
ninoderkinderen 0:8d87bc453349 56 *@return The value of the variable
ninoderkinderen 0:8d87bc453349 57 */
ninoderkinderen 0:8d87bc453349 58 T read(){
ninoderkinderen 0:8d87bc453349 59 return(*_ptr);
ninoderkinderen 0:8d87bc453349 60 }
ninoderkinderen 0:8d87bc453349 61 /**
ninoderkinderen 0:8d87bc453349 62 *Write a value to the variable over RPC
ninoderkinderen 0:8d87bc453349 63 *
ninoderkinderen 0:8d87bc453349 64 *@param The value to be written to the attached variable.
ninoderkinderen 0:8d87bc453349 65 */
ninoderkinderen 0:8d87bc453349 66 void write(T value){
ninoderkinderen 0:8d87bc453349 67 *_ptr = value;
ninoderkinderen 0:8d87bc453349 68 }
ninoderkinderen 0:8d87bc453349 69
ninoderkinderen 0:8d87bc453349 70 #ifdef MBED_RPC
ninoderkinderen 0:8d87bc453349 71 virtual const struct rpc_method *get_rpc_methods();
ninoderkinderen 0:8d87bc453349 72 static struct rpc_class *get_rpc_class();
ninoderkinderen 0:8d87bc453349 73 #endif
ninoderkinderen 0:8d87bc453349 74
ninoderkinderen 0:8d87bc453349 75 private:
ninoderkinderen 0:8d87bc453349 76 T * _ptr;
ninoderkinderen 0:8d87bc453349 77
ninoderkinderen 0:8d87bc453349 78 };
ninoderkinderen 0:8d87bc453349 79
ninoderkinderen 0:8d87bc453349 80 //Set up RPC methods
ninoderkinderen 0:8d87bc453349 81 #ifdef MBED_RPC
ninoderkinderen 0:8d87bc453349 82 template <class T>
ninoderkinderen 0:8d87bc453349 83 const rpc_method *RPCVariable<T>::get_rpc_methods() {
ninoderkinderen 0:8d87bc453349 84 static const rpc_method rpc_methods[] = {
ninoderkinderen 0:8d87bc453349 85 { "read", rpc_method_caller<T, RPCVariable, &RPCVariable::read> },
ninoderkinderen 0:8d87bc453349 86 { "write", rpc_method_caller<RPCVariable, T, &RPCVariable::write> },
ninoderkinderen 0:8d87bc453349 87 RPC_METHOD_SUPER(Base)
ninoderkinderen 0:8d87bc453349 88 };
ninoderkinderen 0:8d87bc453349 89 return rpc_methods;
ninoderkinderen 0:8d87bc453349 90 }
ninoderkinderen 0:8d87bc453349 91 template <class T>
ninoderkinderen 0:8d87bc453349 92 rpc_class *RPCVariable<T>::get_rpc_class() {
ninoderkinderen 0:8d87bc453349 93 static const rpc_function funcs[] = {"new", rpc_function_caller<const char*, T,const char* , &Base::construct<RemoteVar, T ,const char*> >,RPC_METHOD_END};
ninoderkinderen 0:8d87bc453349 94 static rpc_class c = { "RPCVariable", funcs, NULL };
ninoderkinderen 0:8d87bc453349 95 return &c;
ninoderkinderen 0:8d87bc453349 96 }
ninoderkinderen 0:8d87bc453349 97 #endif
ninoderkinderen 0:8d87bc453349 98
ninoderkinderen 0:8d87bc453349 99 //There could be specialisation for integer, to also give increment and decrements
ninoderkinderen 0:8d87bc453349 100
ninoderkinderen 0:8d87bc453349 101
ninoderkinderen 0:8d87bc453349 102 #endif //RPCVARIABLE_H_