1 #ifndef __DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H__
2 #define __DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H__
5 * Copyright (c) 2015 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.
27 namespace PerformanceProtocol
30 const unsigned int MAX_COMMAND_STRING_LENGTH = 256; ///< maximum length of a command including null terminator
33 * @brief List of commands id's
37 HELP_MESSAGE = 0, ///< help message
38 ENABLE_METRIC = 1, ///< enable metric
39 DISABLE_METRIC = 2, ///< disable metric
40 LIST_METRICS_AVAILABLE = 3, ///< list metrics that are available
41 ENABLE_TIME_MARKER_BIT_MASK = 4, ///< bit mask of time markers to enable
42 SET_PROPERTIES = 5, ///< set property
43 DUMP_SCENE_GRAPH = 6, ///< dump the scene graph
44 UNKNOWN_COMMAND = 4096
48 typedef char CommandString[ MAX_COMMAND_STRING_LENGTH ];
51 * @brief given a command id, get the command string
52 * @param[in] commandId command id
53 * @param[out] commandString command string
54 * @return true on success, false on failure
56 bool GetCommandString( CommandId commandId, CommandString& commandString );
59 * @brief given a command string, get the command id and an integer parameter if it exists
60 * @param[in] commandString command string
61 * @param[in] lengthInBytes length of the string
62 * @param[out] commandId command id
63 * @param[out] intParam integer parameter
64 * @param[out] stringParam string parameter
65 * @param true on success, false on failure
67 bool GetCommandId( const char* const commandString,
68 unsigned int lengthInBytes,
70 unsigned int& intParam,
71 std::string& stringParam);
74 * @return the protocol help message for console users
76 const char* const GetHelpMessage();
78 } // namespace PerformanceProtocol
82 #endif //__DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H__