Zainul Charbiwala / BufSerialRPC

Serial RPC Interface using the MODSERIAL library. Does not hang when serial port misbehaves.

RPCVariable.h@3:d5d7e52769e7, 2011-02-04 (annotated)

Committer:
zainulcharbiwala
Date:
Fri Feb 04 01:54:41 2011 +0000
Revision:
3:d5d7e52769e7
Parent:
0:66e48adbb27b 
Added Hexley Ball\s fix for memory leak in RFCFunction

Who changed what in which revision?

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