1 /* 2 * Copyright (c) 2015, Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, this 9 * list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation and/or 13 * other materials provided with the distribution. 14 * 15 * 3. Neither the name of the copyright holder nor the names of its contributors 16 * may be used to endorse or promote products derived from this software without 17 * specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 #pragma once 31 32 #include <string> 33 #include <vector> 34 35 /** Class used to send commands to a parameter framework. 36 * @see the help command for more information on which command can be sent. 37 * @see ParameterMgrFullConnector::createCommandHandler to create an instance. 38 * 39 * This interface is primary designed to send commands without using a 40 * tcp socket for test purposes. 41 * 42 * Note: the fact that this class must be deleted by the client is because the 43 * PF interface is not c++11. 44 * TODO: When the interface will transition to C++11, return directly the 45 * CommandHandlerWrapper as this base class only use is to hide the 46 * move semantic that is not supported in C++03. 47 */ 48 class CommandHandlerInterface 49 { 50 public: 51 /** Send a command synchronously and receive it's result. 52 * 53 * @see CParameterMgr::gastRemoteCommandParserItems for the list of possible 54 * command and their description. 55 * 56 * @param[in] command the command to execute. 57 * @param[in] arguments the command arguments. 58 * @param[out] output the result of the command. 59 * 60 * return true in the command executed succesfuly, 61 * false otherwise. 62 */ 63 virtual bool process(const std::string &command, const std::vector<std::string> &arguments, 64 std::string &output) = 0; 65 66 virtual ~CommandHandlerInterface(){}; 67 }; 68
