1 #ifndef DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H
2 #define DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
26 namespace PerformanceProtocol
28 const unsigned int MAX_COMMAND_STRING_LENGTH = 256; ///< maximum length of a command including null terminator
31 * @brief List of commands id's
35 HELP_MESSAGE = 0, ///< help message
36 ENABLE_METRIC = 1, ///< enable metric
37 DISABLE_METRIC = 2, ///< disable metric
38 LIST_METRICS_AVAILABLE = 3, ///< list metrics that are available
39 ENABLE_TIME_MARKER_BIT_MASK = 4, ///< bit mask of time markers to enable
40 SET_PROPERTIES = 5, ///< set property
41 DUMP_SCENE_GRAPH = 6, ///< dump the scene graph
42 CUSTOM_COMMAND = 7, ///< custom command for the application
43 UNKNOWN_COMMAND = 4096
46 typedef char CommandString[MAX_COMMAND_STRING_LENGTH];
49 * @brief given a command id, get the command string
50 * @param[in] commandId command id
51 * @param[out] commandString command string
52 * @return true on success, false on failure
54 bool GetCommandString(CommandId commandId, CommandString& commandString);
57 * @brief given a command string, get the command id and an integer parameter if it exists
58 * @param[in] commandString command string
59 * @param[in] lengthInBytes length of the string
60 * @param[out] commandId command id
61 * @param[out] intParam integer parameter
62 * @param[out] stringParam string parameter
63 * @param true on success, false on failure
65 bool GetCommandId(const char* const commandString,
66 unsigned int lengthInBytes,
68 unsigned int& intParam,
69 std::string& stringParam);
72 * @return the protocol help message for console users
74 const char* const GetHelpMessage();
76 } // namespace PerformanceProtocol
80 #endif //DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H