diff options
author | Luca Muscariello <lumuscar+fdio@cisco.com> | 2019-03-24 14:07:14 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2019-03-24 14:07:14 +0000 |
commit | 777974a5b295cbe7ff762358ac3e9dac4c502aaf (patch) | |
tree | 5717f6875665ec70fd3540487ec00539a1ec37b9 /hicn-light/src/hicn/config/commandReturn.h | |
parent | d7e4753b9d8035f4898989708bf1dbcd79e59585 (diff) | |
parent | eb323e056e747d71867cf965434811c1de925de2 (diff) |
Merge "[HICN-141] Definition of a C API for hicn-light"
Diffstat (limited to 'hicn-light/src/hicn/config/commandReturn.h')
-rw-r--r-- | hicn-light/src/hicn/config/commandReturn.h | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/hicn-light/src/hicn/config/commandReturn.h b/hicn-light/src/hicn/config/commandReturn.h new file mode 100644 index 000000000..16ee93db1 --- /dev/null +++ b/hicn-light/src/hicn/config/commandReturn.h @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2017-2019 Cisco and/or its affiliates. + * 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. + */ + +/** + * @file command_Return.h + * @brief The return code used by CLI commands + * + * This return code is used throughout the command parser and command + * implementations to indicate success, failure, or if the program should exit. + * + */ + +#ifndef command_return_h +#define command_return_h + +/** + * @typedef ControlReturn + * @abstract A command returns one of (SUCCESS, FAILURE, EXIT) + * @constant SUCCESS means the command succeeded + * @constant FAILURE indicates failure + * @constant EXIT means the command indicated that hicn-light controller should + * exit. + * @discussion <#Discussion#> + */ +typedef enum command_return { + CommandReturn_Success, // command returned success + CommandReturn_Failure, // command failure + CommandReturn_Exit // command indicates program should exit +} CommandReturn; + +#endif // command_return_h |