Dali 3D User Interface Engine
Namespaces | Typedefs | Enumerations | Functions | Variables
Dali::PerformanceProtocol Namespace Reference

Namespaces

namespace  anonymous_namespace{network-performance-protocol.cpp}
 

Typedefs

typedef char CommandString [MAX_COMMAND_STRING_LENGTH]
 

Enumerations

enum  CommandId {
  HELP_MESSAGE = 0, ENABLE_METRIC = 1, DISABLE_METRIC = 2, LIST_METRICS_AVAILABLE = 3,
  ENABLE_TIME_MARKER_BIT_MASK = 4, SET_PROPERTIES = 5, DUMP_SCENE_GRAPH = 6, UNKNOWN_COMMAND = 4096
}
 List of commands id's. More...
 

Functions

bool GetCommandId (const char *const commandString, unsigned int lengthInBytes, CommandId &commandId, unsigned int &intParam, std::string &stringParam)
 given a command string, get the command id and an integer parameter if it exists More...
 
bool GetCommandString (CommandId commandId, CommandString &commandString)
 given a command id, get the command string More...
 
const char *const GetHelpMessage ()
 

Variables

const unsigned int MAX_COMMAND_STRING_LENGTH = 256
 maximum length of a command including null terminator More...
 

Typedef Documentation

typedef char Dali::PerformanceProtocol::CommandString[MAX_COMMAND_STRING_LENGTH]

Definition at line 48 of file network-performance-protocol.h.

Enumeration Type Documentation

List of commands id's.

Enumerator
HELP_MESSAGE 

help message

ENABLE_METRIC 

enable metric

DISABLE_METRIC 

disable metric

LIST_METRICS_AVAILABLE 

list metrics that are available

ENABLE_TIME_MARKER_BIT_MASK 

bit mask of time markers to enable

SET_PROPERTIES 

set property

DUMP_SCENE_GRAPH 

dump the scene graph

UNKNOWN_COMMAND 

Definition at line 35 of file network-performance-protocol.h.

Function Documentation

bool Dali::PerformanceProtocol::GetCommandId ( const char *const  commandString,
unsigned int  lengthInBytes,
CommandId &  commandId,
unsigned int &  intParam,
std::string &  stringParam 
)

given a command string, get the command id and an integer parameter if it exists

Parameters
[in]commandStringcommand string
[in]lengthInByteslength of the string
[out]commandIdcommand id
[out]intParaminteger parameter
[out]stringParamstring parameter
trueon success, false on failure

Definition at line 103 of file network-performance-protocol.cpp.

References Dali::PerformanceProtocol::anonymous_namespace{network-performance-protocol.cpp}::CommandInfo::cmdId, Dali::PerformanceProtocol::anonymous_namespace{network-performance-protocol.cpp}::CommandLookupLength, Dali::PerformanceProtocol::anonymous_namespace{network-performance-protocol.cpp}::STRING, UNKNOWN_COMMAND, and Dali::PerformanceProtocol::anonymous_namespace{network-performance-protocol.cpp}::UNSIGNED_INT.

Referenced by Dali::Internal::Adaptor::NetworkPerformanceClient::ProcessCommand().

Here is the caller graph for this function:

bool Dali::PerformanceProtocol::GetCommandString ( CommandId  commandId,
CommandString &  commandString 
)

given a command id, get the command string

Parameters
[in]commandIdcommand id
[out]commandStringcommand string
Returns
true on success, false on failure

Definition at line 145 of file network-performance-protocol.cpp.

References Dali::PerformanceProtocol::anonymous_namespace{network-performance-protocol.cpp}::CommandLookupLength, MAX_COMMAND_STRING_LENGTH, and UNKNOWN_COMMAND.

const char *const Dali::PerformanceProtocol::GetHelpMessage ( )
Returns
the protocol help message for console users

Definition at line 159 of file network-performance-protocol.cpp.

References Dali::PerformanceProtocol::anonymous_namespace{network-performance-protocol.cpp}::helpMsg.

Referenced by Dali::Internal::Adaptor::NetworkPerformanceClient::ProcessCommand().

Here is the caller graph for this function:

Variable Documentation

const unsigned int Dali::PerformanceProtocol::MAX_COMMAND_STRING_LENGTH = 256

maximum length of a command including null terminator

Definition at line 30 of file network-performance-protocol.h.

Referenced by GetCommandString().

Dali Docs Home
Read more about Dali