Robin Hourahane / Improved-mbed-rpc

Improved RPC library with added bounds checking to stop memory corruption, removed memory leaks, Arduino pin names, better object discovery.

Fork of mbed-rpc by mbed official

I have added bounds checking in both Argument and Reply classes to stop existing buffer over-runs in both classes.

Added the ability to discover the name and class of an RPC object to allow better discovery of existing objects on a server. Removed a memory leak with externally created RPC objects. Ensured consistency so that externally created objects can't be deleted using the RPC interface and are correctly listed after RPC::clear.

Updated RPCVariable to use references instead of pointers to ensure that the compiler checks that there is always a valid backing variable. Also removed RPC new/delete functionality as this is not valid. Added a specialisation of RPCVariable to allow for strings to be read and written via RPC.

Added Arduino pin names to parse_pins, currently only for FRDM boards but same code should work for others just need to add them to the #ifdef.

RPCFunction.h

Committer:
rhourahane
Date:
2015-03-30
Revision:
10:7511acfaa62d
Parent:
1:6919289a5946

File content as of revision 10:7511acfaa62d:

/* mbed Microcontroller Library
 * Copyright (c) 2006-2013 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef RPCFUNCTION_RPC
#define RPCFUNCTION_RPC

#include "rpc.h"
#define STR_LEN 64

namespace mbed {

/**
 *
 *Class to call custom functions over RPC
 *
 */
class RPCFunction: public RPC {
public:
    /**
     * Constructor
     *
     *@param f Pointer to the function to call. the function must be of the form void foo(char * input, char * output)
     *@param name The name of this object
     */
    RPCFunction(void (*f)(Arguments*, Reply*), const char* = NULL);

    /**
     *run
     *
     *Calls the attached function passing the string in but doesn't return the result.
     *@param str The string to be passed into the attached function. This string can consist of any ASCII characters apart from escape codes. The usual limtations on argument content for RPC strings has been removed
     *@return A string output from the function
     */
    void run(Arguments* args, Reply* r);

    virtual const struct rpc_method *get_rpc_methods();

private:
    void (*_ftr)(Arguments*, Reply*);

    char _input[STR_LEN];
    char _output[STR_LEN];
};

}

#endif