dali/internal/network/common/network-performance-protocol.h

   1 #ifndef DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H
   2 #define DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 namespace Dali
  25 {
  26 namespace PerformanceProtocol
  27 {
  28 const unsigned int MAX_COMMAND_STRING_LENGTH = 256; ///< maximum length of a command including null terminator
  29
  30 /**
  31  * @brief List of commands id's
  32  */
  33 enum CommandId
  34 {
  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   UNKNOWN_COMMAND             = 4096
  43 };
  44
  45 typedef char CommandString[MAX_COMMAND_STRING_LENGTH];
  46
  47 /**
  48  * @brief given a command id, get the command string
  49  * @param[in] commandId command id
  50  * @param[out] commandString command string
  51  * @return true on success, false on failure
  52  */
  53 bool GetCommandString(CommandId commandId, CommandString& commandString);
  54
  55 /**
  56  * @brief given a command string, get the command id and an integer parameter if it exists
  57  * @param[in] commandString command string
  58  * @param[in] lengthInBytes length of the string
  59  * @param[out] commandId command id
  60  * @param[out] intParam integer parameter
  61  * @param[out] stringParam string parameter
  62  * @param true on success, false on failure
  63  */
  64 bool GetCommandId(const char* const commandString,
  65                   unsigned int      lengthInBytes,
  66                   CommandId&        commandId,
  67                   unsigned int&     intParam,
  68                   std::string&      stringParam);
  69
  70 /**
  71  * @return the protocol help message for console users
  72  */
  73 const char* const GetHelpMessage();
  74
  75 } // namespace PerformanceProtocol
  76
  77 } // namespace Dali
  78
  79 #endif //DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H