test public
Dependencies: HttpServer_snapshot_mbed-os
mbed-rpc/RPCVariable.h@0:e9fd5575b10e, 2019-10-18 (annotated)
- Committer:
- anhtran
- Date:
- Fri Oct 18 03:09:43 2019 +0000
- Revision:
- 0:e9fd5575b10e
abc
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
anhtran | 0:e9fd5575b10e | 1 | /* mbed Microcontroller Library |
anhtran | 0:e9fd5575b10e | 2 | * Copyright (c) 2006-2013 ARM Limited |
anhtran | 0:e9fd5575b10e | 3 | * |
anhtran | 0:e9fd5575b10e | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
anhtran | 0:e9fd5575b10e | 5 | * you may not use this file except in compliance with the License. |
anhtran | 0:e9fd5575b10e | 6 | * You may obtain a copy of the License at |
anhtran | 0:e9fd5575b10e | 7 | * |
anhtran | 0:e9fd5575b10e | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
anhtran | 0:e9fd5575b10e | 9 | * |
anhtran | 0:e9fd5575b10e | 10 | * Unless required by applicable law or agreed to in writing, software |
anhtran | 0:e9fd5575b10e | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
anhtran | 0:e9fd5575b10e | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
anhtran | 0:e9fd5575b10e | 13 | * See the License for the specific language governing permissions and |
anhtran | 0:e9fd5575b10e | 14 | * limitations under the License. |
anhtran | 0:e9fd5575b10e | 15 | */ |
anhtran | 0:e9fd5575b10e | 16 | #ifndef RPCVARIABLE_H_ |
anhtran | 0:e9fd5575b10e | 17 | #define RPCVARIABLE_H_ |
anhtran | 0:e9fd5575b10e | 18 | |
anhtran | 0:e9fd5575b10e | 19 | #include "rpc.h" |
anhtran | 0:e9fd5575b10e | 20 | |
anhtran | 0:e9fd5575b10e | 21 | namespace mbed { |
anhtran | 0:e9fd5575b10e | 22 | |
anhtran | 0:e9fd5575b10e | 23 | /** |
anhtran | 0:e9fd5575b10e | 24 | *Class to read and set an attached variable using the RPC |
anhtran | 0:e9fd5575b10e | 25 | * |
anhtran | 0:e9fd5575b10e | 26 | */ |
anhtran | 0:e9fd5575b10e | 27 | template<class T> |
anhtran | 0:e9fd5575b10e | 28 | class RPCVariable: public RPC { |
anhtran | 0:e9fd5575b10e | 29 | public: |
anhtran | 0:e9fd5575b10e | 30 | /** |
anhtran | 0:e9fd5575b10e | 31 | * Constructor |
anhtran | 0:e9fd5575b10e | 32 | * |
anhtran | 0:e9fd5575b10e | 33 | *@param ptr Pointer to the variable to make accessible over RPC. Any type of |
anhtran | 0:e9fd5575b10e | 34 | *variable can be connected |
anhtran | 0:e9fd5575b10e | 35 | *@param name The name of that this object will be over RPC |
anhtran | 0:e9fd5575b10e | 36 | */ |
anhtran | 0:e9fd5575b10e | 37 | template<class A> |
anhtran | 0:e9fd5575b10e | 38 | RPCVariable(A * ptr, const char * name) : RPC(name) { |
anhtran | 0:e9fd5575b10e | 39 | _ptr = ptr; |
anhtran | 0:e9fd5575b10e | 40 | } |
anhtran | 0:e9fd5575b10e | 41 | /** |
anhtran | 0:e9fd5575b10e | 42 | *Read the variable over RPC. |
anhtran | 0:e9fd5575b10e | 43 | * |
anhtran | 0:e9fd5575b10e | 44 | *@return The value of the variable |
anhtran | 0:e9fd5575b10e | 45 | */ |
anhtran | 0:e9fd5575b10e | 46 | T read() { |
anhtran | 0:e9fd5575b10e | 47 | return (*_ptr); |
anhtran | 0:e9fd5575b10e | 48 | } |
anhtran | 0:e9fd5575b10e | 49 | /** |
anhtran | 0:e9fd5575b10e | 50 | *Write a value to the variable over RPC |
anhtran | 0:e9fd5575b10e | 51 | * |
anhtran | 0:e9fd5575b10e | 52 | *@param The value to be written to the attached variable. |
anhtran | 0:e9fd5575b10e | 53 | */ |
anhtran | 0:e9fd5575b10e | 54 | void write(T value) { |
anhtran | 0:e9fd5575b10e | 55 | *_ptr = value; |
anhtran | 0:e9fd5575b10e | 56 | } |
anhtran | 0:e9fd5575b10e | 57 | |
anhtran | 0:e9fd5575b10e | 58 | virtual const struct rpc_method *get_rpc_methods(); |
anhtran | 0:e9fd5575b10e | 59 | static struct rpc_class *get_rpc_class(); |
anhtran | 0:e9fd5575b10e | 60 | |
anhtran | 0:e9fd5575b10e | 61 | private: |
anhtran | 0:e9fd5575b10e | 62 | T * _ptr; |
anhtran | 0:e9fd5575b10e | 63 | }; |
anhtran | 0:e9fd5575b10e | 64 | |
anhtran | 0:e9fd5575b10e | 65 | template<class T> |
anhtran | 0:e9fd5575b10e | 66 | const rpc_method *RPCVariable<T>::get_rpc_methods() { |
anhtran | 0:e9fd5575b10e | 67 | static const rpc_method rpc_methods[] = { |
anhtran | 0:e9fd5575b10e | 68 | {"read" , rpc_method_caller<T, RPCVariable, &RPCVariable::read> }, |
anhtran | 0:e9fd5575b10e | 69 | {"write", rpc_method_caller<RPCVariable, T, &RPCVariable::write> }, |
anhtran | 0:e9fd5575b10e | 70 | RPC_METHOD_SUPER(RPC) |
anhtran | 0:e9fd5575b10e | 71 | }; |
anhtran | 0:e9fd5575b10e | 72 | return rpc_methods; |
anhtran | 0:e9fd5575b10e | 73 | } |
anhtran | 0:e9fd5575b10e | 74 | |
anhtran | 0:e9fd5575b10e | 75 | template<class T> |
anhtran | 0:e9fd5575b10e | 76 | rpc_class *RPCVariable<T>::get_rpc_class() { |
anhtran | 0:e9fd5575b10e | 77 | static const rpc_function funcs[] = { |
anhtran | 0:e9fd5575b10e | 78 | "new", rpc_function_caller<const char*, T, const char*, &RPC::construct<RPCVariable, T, const char*> > , |
anhtran | 0:e9fd5575b10e | 79 | RPC_METHOD_END |
anhtran | 0:e9fd5575b10e | 80 | }; |
anhtran | 0:e9fd5575b10e | 81 | static rpc_class c = {"RPCVariable", funcs, NULL}; |
anhtran | 0:e9fd5575b10e | 82 | return &c; |
anhtran | 0:e9fd5575b10e | 83 | } |
anhtran | 0:e9fd5575b10e | 84 | |
anhtran | 0:e9fd5575b10e | 85 | } |
anhtran | 0:e9fd5575b10e | 86 | |
anhtran | 0:e9fd5575b10e | 87 | #endif //RPCVARIABLE_H_ |
anhtran | 0:e9fd5575b10e | 88 |