Zainul Charbiwala / BufSerialRPC

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

RPCFunction.cpp@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 which can be called over RPC to run the function which is attached to it.
zainulcharbiwala 0:66e48adbb27b 25 *
zainulcharbiwala 0:66e48adbb27b 26 */
zainulcharbiwala 0:66e48adbb27b 27 #include "RPCFunction.h"
zainulcharbiwala 0:66e48adbb27b 28 #include "rpc.h"
zainulcharbiwala 0:66e48adbb27b 29
zainulcharbiwala 0:66e48adbb27b 30 //Parse a char argument without delimiting by anything that is non alphanumeric - based on version in rpc.h line 153
zainulcharbiwala 0:66e48adbb27b 31 char *parse_arg_char(const char *arg, const char **next) {
zainulcharbiwala 0:66e48adbb27b 32 const char *ptr = arg;
zainulcharbiwala 0:66e48adbb27b 33 char *res = NULL;
zainulcharbiwala 0:66e48adbb27b 34 if(*arg == '"') {
zainulcharbiwala 0:66e48adbb27b 35 /* quoted string */
zainulcharbiwala 0:66e48adbb27b 36 ptr = ++arg;
zainulcharbiwala 0:66e48adbb27b 37 int len = 0;
zainulcharbiwala 0:66e48adbb27b 38 /* find the end (and length) of the quoted string */
zainulcharbiwala 0:66e48adbb27b 39 for(char c = *ptr; c != 0 && c != '"'; c = *++ptr) {
zainulcharbiwala 0:66e48adbb27b 40 len++;
zainulcharbiwala 0:66e48adbb27b 41 if(c == '\\') {
zainulcharbiwala 0:66e48adbb27b 42 ptr++;
zainulcharbiwala 0:66e48adbb27b 43 }
zainulcharbiwala 0:66e48adbb27b 44 }
zainulcharbiwala 0:66e48adbb27b 45 /* copy the quoted string, and unescape characters */
zainulcharbiwala 0:66e48adbb27b 46 if(len != 0) {
zainulcharbiwala 0:66e48adbb27b 47 res = new char[len+1];
zainulcharbiwala 0:66e48adbb27b 48 char *resptr = res;
zainulcharbiwala 0:66e48adbb27b 49 while(arg != ptr) {
zainulcharbiwala 0:66e48adbb27b 50 *resptr++ = parse_char(arg, &arg);
zainulcharbiwala 0:66e48adbb27b 51 }
zainulcharbiwala 0:66e48adbb27b 52 *resptr = 0;
zainulcharbiwala 0:66e48adbb27b 53 }
zainulcharbiwala 0:66e48adbb27b 54 } else {
zainulcharbiwala 0:66e48adbb27b 55 /* unquoted string */
zainulcharbiwala 0:66e48adbb27b 56 while(isalnum(*ptr) || isgraph(*ptr) || *ptr=='_' || *ptr == ' ') { //Edit this line to change which types of characters are allowed and which delimit
zainulcharbiwala 0:66e48adbb27b 57 ptr++;
zainulcharbiwala 0:66e48adbb27b 58 }
zainulcharbiwala 0:66e48adbb27b 59 int len = ptr-arg;
zainulcharbiwala 0:66e48adbb27b 60 if(len!=0) { //Chnages made to just pass whole string with no next arg or delimiters, these changes just removes space at the beginning
zainulcharbiwala 0:66e48adbb27b 61 res = new char[len]; //was len+1
zainulcharbiwala 0:66e48adbb27b 62 memcpy(res, arg + 1, len - 1); // was arg, len
zainulcharbiwala 0:66e48adbb27b 63 res[len-1] = 0; //was len
zainulcharbiwala 0:66e48adbb27b 64 }
zainulcharbiwala 0:66e48adbb27b 65 }
zainulcharbiwala 0:66e48adbb27b 66
zainulcharbiwala 0:66e48adbb27b 67 if(next != NULL) {
zainulcharbiwala 0:66e48adbb27b 68 *next = ptr;
zainulcharbiwala 0:66e48adbb27b 69 }
zainulcharbiwala 0:66e48adbb27b 70 return res;
zainulcharbiwala 0:66e48adbb27b 71 }
zainulcharbiwala 0:66e48adbb27b 72
zainulcharbiwala 0:66e48adbb27b 73 //Custom rpc method caller for execute so that the string will not be delimited by anything
zainulcharbiwala 0:66e48adbb27b 74 //See line 436 of rpc.h
zainulcharbiwala 0:66e48adbb27b 75 void rpc_method_caller_run(Base *this_ptr, const char *arguments, char *result) {
zainulcharbiwala 0:66e48adbb27b 76
zainulcharbiwala 0:66e48adbb27b 77 const char *next = arguments;
zainulcharbiwala 0:66e48adbb27b 78 char* arg1 = parse_arg_char(next,NULL);
zainulcharbiwala 0:66e48adbb27b 79
zainulcharbiwala 0:66e48adbb27b 80 char * res = (static_cast<RPCFunction*>(this_ptr)->run)(arg1);
zainulcharbiwala 0:66e48adbb27b 81 if(result != NULL) {
zainulcharbiwala 0:66e48adbb27b 82 write_result<char*>(res, result);
zainulcharbiwala 0:66e48adbb27b 83 }
zainulcharbiwala 3:d5d7e52769e7 84 delete arg1; // Seems to stop a memory leak issue //From Hexley Ball
zainulcharbiwala 0:66e48adbb27b 85 }
zainulcharbiwala 0:66e48adbb27b 86
zainulcharbiwala 0:66e48adbb27b 87 RPCFunction::RPCFunction(void(*f)(char*, char*), const char* name) : Base(name){
zainulcharbiwala 0:66e48adbb27b 88 _ftr = f;
zainulcharbiwala 0:66e48adbb27b 89 }
zainulcharbiwala 0:66e48adbb27b 90
zainulcharbiwala 0:66e48adbb27b 91
zainulcharbiwala 0:66e48adbb27b 92 //Just run the attached function using the string thats in private memory - or just using null values,
zainulcharbiwala 0:66e48adbb27b 93 char * RPCFunction::run(char * input){
zainulcharbiwala 0:66e48adbb27b 94 strcpy(_input, input);
zainulcharbiwala 0:66e48adbb27b 95 (*_ftr)(_input,_output);
zainulcharbiwala 0:66e48adbb27b 96 return(_output);
zainulcharbiwala 0:66e48adbb27b 97 }
zainulcharbiwala 0:66e48adbb27b 98
zainulcharbiwala 0:66e48adbb27b 99 //Just read the output string
zainulcharbiwala 0:66e48adbb27b 100 char* RPCFunction::read(){
zainulcharbiwala 0:66e48adbb27b 101 return(_output);
zainulcharbiwala 0:66e48adbb27b 102 }
zainulcharbiwala 0:66e48adbb27b 103
zainulcharbiwala 0:66e48adbb27b 104
zainulcharbiwala 0:66e48adbb27b 105 #ifdef MBED_RPC
zainulcharbiwala 0:66e48adbb27b 106 const rpc_method *RPCFunction::get_rpc_methods() {
zainulcharbiwala 0:66e48adbb27b 107 static const rpc_method rpc_methods[] = {
zainulcharbiwala 0:66e48adbb27b 108 { "run", rpc_method_caller_run }, //Run using custom caller, all characters accepted in string
zainulcharbiwala 0:66e48adbb27b 109 { "read", rpc_method_caller<char*, RPCFunction, &RPCFunction::read> },
zainulcharbiwala 0:66e48adbb27b 110 RPC_METHOD_SUPER(Base)
zainulcharbiwala 0:66e48adbb27b 111 };
zainulcharbiwala 0:66e48adbb27b 112 return rpc_methods;
zainulcharbiwala 0:66e48adbb27b 113 }
zainulcharbiwala 0:66e48adbb27b 114
zainulcharbiwala 0:66e48adbb27b 115 #endif