diff options
| author |   Dan Klein <danklei@cisco.com> | 2015-08-23 18:52:11 +0300 |
|---|---|---|
| committer | Dan Klein <danklei@cisco.com> | 2015-08-23 18:52:11 +0300 |
| commit | 651a7d779551e193bd9dbadbe8b2a02bdab231b4 (patch) | |
| tree | a42cb5ab0eca820899f9fedf538eef8d83ad4383 /src/rpc-server/include/trex_rpc_cmd_api.h | |
| parent | 84bb24ace632141dd5ece01d5f4985239014f660 (diff) | |
| parent | 3bfe53394f43a37ce02b09c6420751027c602047 (diff) | |
Merge branch 'master' into dan_latest
Diffstat (limited to 'src/rpc-server/include/trex_rpc_cmd_api.h')
| -rw-r--r-- | src/rpc-server/include/trex_rpc_cmd_api.h | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/src/rpc-server/include/trex_rpc_cmd_api.h b/src/rpc-server/include/trex_rpc_cmd_api.h new file mode 100644 index 00000000..c773b15f --- /dev/null +++ b/src/rpc-server/include/trex_rpc_cmd_api.h @@ -0,0 +1,90 @@ +/* + Itay Marom + Cisco Systems, Inc. +*/ + +/* +Copyright (c) 2015-2015 Cisco Systems, Inc. + +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 __TREX_RPC_CMD_API_H__ +#define __TREX_RPC_CMD_API_H__ + +#include <string> +#include <vector> +#include <json/json.h> + +/** + * interface for RPC command + * + * @author imarom (13-Aug-15) + */ +class TrexRpcCommand { +public: + + /** + * describe different types of rc for run() + */ + enum rpc_cmd_rc_e { + RPC_CMD_OK, + RPC_CMD_PARAM_COUNT_ERR = 1, + RPC_CMD_PARAM_PARSE_ERR, + RPC_CMD_INTERNAL_ERR + }; + + /** + * method name and params + */ + TrexRpcCommand(const std::string &method_name) : m_name(method_name) { + + } + + rpc_cmd_rc_e run(const Json::Value ¶ms, Json::Value &result) { + return _run(params, result); + } + + const std::string &get_name() { + return m_name; + } + + virtual ~TrexRpcCommand() {} + +protected: + + /** + * implemented by the dervied class + * + */ + virtual rpc_cmd_rc_e _run(const Json::Value ¶ms, Json::Value &result) = 0; + + /** + * error generating functions + * + */ + void genernate_err(Json::Value &result, const std::string &msg) { + result["specific_err"] = msg; + } + + void generate_err_param_count(Json::Value &result, int expected, int provided) { + std::stringstream ss; + ss << "method expects '" << expected << "' paramteres, '" << provided << "' provided"; + genernate_err(result, ss.str()); + } + + std::string m_name; +}; + +#endif /* __TREX_RPC_CMD_API_H__ */ + |