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) 2015 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
  27 namespace PerformanceProtocol
  28 {
  29
  30 const unsigned int MAX_COMMAND_STRING_LENGTH = 256;  ///< maximum length of a command including null terminator
  31
  32 /**
  33  * @brief List of commands id's
  34  */
  35 enum CommandId
  36 {
  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
  45 };
  46
  47
  48 typedef char CommandString[ MAX_COMMAND_STRING_LENGTH ];
  49
  50 /**
  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
  55  */
  56 bool GetCommandString( CommandId commandId, CommandString& commandString );
  57
  58 /**
  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
  66  */
  67 bool GetCommandId( const char* const commandString,
  68                    unsigned int lengthInBytes,
  69                    CommandId& commandId,
  70                    unsigned int& intParam,
  71                    std::string& stringParam);
  72
  73 /**
  74  * @return the protocol help message for console users
  75  */
  76 const char* const GetHelpMessage();
  77
  78 } // namespace PerformanceProtocol
  79
  80 } // namespace Dali
  81
  82 #endif //__DALI_INTERNAL_ADAPTOR_NETWORK_PERFORMANCE_PROTOCOL_H__