fesa::DiagnosticUtils Namespace Reference

Classes

struct  DiagStateCounter
 Diagnostic state counting information. More...
struct  DiagnosticMessage
 Diagnostic message. More...

Typedefs

typedef std::vector< std::pair
< int, std::string > > 
DiagnosticTopics
 A type for a list of framework/user diagnostic topics. Each element of the list is a pair of a bit-mask and a topic name. Topics are defined in a bit-enum, the bit-mask is used to check if a given topic is enabled.

Enumerations

enum  State {
  initDiag = 1 << 0, startDiag = 1 << 1, stopDiag = 1 << 2, requestState = 1 << 3,
  updateFwkTopic = 1 << 4, updateCustomTopic = 1 << 5, updateTsPeriod = 1 << 6
}
 

Specific actions to be activated on RT process during diagnostic setting.

More...
enum  FrameworkTopic {
  getActionProfiling = 1 << 0, setActionProfiling = 1 << 1, rtActionProfiling = 1 << 2, eventProfiling = 1 << 3,
  notificationProfiling = 1 << 4, getActionTracking = 1 << 5, setActionTracking = 1 << 6, rtActionTracking = 1 << 7,
  eventTracking = 1 << 8, notificationTracking = 1 << 9, persistencyTracking = 1 << 10, transactionTracking = 1 << 11,
  subscriptionTracking = 1 << 12, signalHandlerTracking = 1 << 13, rdaTracking = 1 << 14, startUpTracking = 1 << 15
}
 

Bit-enum of framework diagnostic topics.

More...
enum  Side { framework = 0, user = 1 }
 

Sides on which logging is performed.

More...
enum  Action { undefined = 0, start = 1, stop = 2 }
 

Actions for USR traces to be displayed in the profiler In case of modification, don't forget to update 'logActionStr' string-table. TODO: Change this doc, it was coppied from FesaLogger.h.

More...
enum  Source {
  main = 0, rt = 1, server = 2, event = 3,
  notification = 4
}
 

Source of the logging message.

More...

Functions

std::string convertFwkTopicToString (FrameworkTopic topic)
 Convert the topic enumeration value to string.
std::string convertActionToString (Action action)
 Convert the action enumeration value to string.
std::string convertSideToString (Side side)
 Convert the logging side enumeration value to string.
std::string convertSourceToString (Source source)
 Convert the souce of the logging message enumeration value to string.
std::string formatMessage (const DiagnosticMessage &diagMsg)
 Construct a string based on the diagnostic message structure.

Variables

const std::string fwkDiagLoggerNamePrefix = "FESA.DIAG.FWK."
const std::string userDiagLoggerNamePrefix = "FESA.DIAG.USR."
const std::string getActionProfilingStr = "GetActionProfiling"
const std::string setActionProfilingStr = "SetActionProfiling"
const std::string rtActionProfilingStr = "RTActionProfiling"
const std::string eventProfilingStr = "EventProfiling"
const std::string notificationProfilingStr = "NotificationProfiling"
const std::string getActionTrackingStr = "GetActionTracking"
const std::string setActionTrackingStr = "SetActionTracking"
const std::string rtActionTrackingStr = "RTActionTracking"
const std::string eventTrackingStr = "EventTracking"
const std::string notificationTrackingStr = "NotificationTracking"
const std::string persistencyTrackingStr = "PersistencyTracking"
const std::string transactionTrackingStr = "TransactionTracking"
const std::string subscriptionTrackingStr = "SubscriptionTracking"
const std::string signalHandlerTrackingStr = "SignalHandlerTracking"
const std::string rdaTrackingStr = "RDATracking"
const std::string startUpTrackingStr = "StartUpTracking"

Typedef Documentation

typedef std::vector<std::pair<int, std::string> > fesa::DiagnosticUtils::DiagnosticTopics

A type for a list of framework/user diagnostic topics. Each element of the list is a pair of a bit-mask and a topic name. Topics are defined in a bit-enum, the bit-mask is used to check if a given topic is enabled.

Definition at line 61 of file DiagnosticUtils.h.


Enumeration Type Documentation

Actions for USR traces to be displayed in the profiler In case of modification, don't forget to update 'logActionStr' string-table. TODO: Change this doc, it was coppied from FesaLogger.h.

Enumerator:
undefined 
start 
stop 

Definition at line 125 of file DiagnosticUtils.h.

Bit-enum of framework diagnostic topics.

Enumerator:
getActionProfiling 
setActionProfiling 
rtActionProfiling 
eventProfiling 
notificationProfiling 
getActionTracking 
setActionTracking 
rtActionTracking 
eventTracking 
notificationTracking 
persistencyTracking 
transactionTracking 
subscriptionTracking 
signalHandlerTracking 
rdaTracking 
startUpTracking 

Definition at line 91 of file DiagnosticUtils.h.

Sides on which logging is performed.

Enumerator:
framework 
user 

Definition at line 114 of file DiagnosticUtils.h.

Source of the logging message.

Enumerator:
main 
rt 
server 
event 
notification 

Definition at line 135 of file DiagnosticUtils.h.

Specific actions to be activated on RT process during diagnostic setting.

Enumerator:
initDiag 
startDiag 
stopDiag 
requestState 
updateFwkTopic 
updateCustomTopic 
updateTsPeriod 

Definition at line 77 of file DiagnosticUtils.h.


Function Documentation

std::string fesa::DiagnosticUtils::convertActionToString ( Action  action  ) 

Convert the action enumeration value to string.

Parameters:
[in] action The action to convert to string
Returns:
The string representation of the action

Definition at line 56 of file DiagnosticUtils.cpp.

References start, stop, and undefined.

Referenced by formatMessage().

std::string fesa::DiagnosticUtils::convertFwkTopicToString ( FrameworkTopic  topic  ) 
std::string fesa::DiagnosticUtils::convertSideToString ( Side  side  ) 

Convert the logging side enumeration value to string.

Parameters:
[in] side The logging side to convert to string
Returns:
The string representation of the logging side

Definition at line 73 of file DiagnosticUtils.cpp.

References framework, and user.

Referenced by formatMessage().

std::string fesa::DiagnosticUtils::convertSourceToString ( Source  source  ) 

Convert the souce of the logging message enumeration value to string.

Parameters:
[in] source The source to convert to string
Returns:
The string representation of the source

Definition at line 88 of file DiagnosticUtils.cpp.

References main, notification, rt, and server.

Referenced by formatMessage().

std::string fesa::DiagnosticUtils::formatMessage ( const DiagnosticMessage &  diagMsg  ) 

Variable Documentation

const std::string fesa::DiagnosticUtils::eventProfilingStr = "EventProfiling"
const std::string fesa::DiagnosticUtils::eventTrackingStr = "EventTracking"
const std::string fesa::DiagnosticUtils::fwkDiagLoggerNamePrefix = "FESA.DIAG.FWK."
const std::string fesa::DiagnosticUtils::getActionProfilingStr = "GetActionProfiling"
const std::string fesa::DiagnosticUtils::getActionTrackingStr = "GetActionTracking"
const std::string fesa::DiagnosticUtils::notificationProfilingStr = "NotificationProfiling"
const std::string fesa::DiagnosticUtils::notificationTrackingStr = "NotificationTracking"
const std::string fesa::DiagnosticUtils::persistencyTrackingStr = "PersistencyTracking"
const std::string fesa::DiagnosticUtils::rdaTrackingStr = "RDATracking"
const std::string fesa::DiagnosticUtils::rtActionProfilingStr = "RTActionProfiling"
const std::string fesa::DiagnosticUtils::rtActionTrackingStr = "RTActionTracking"
const std::string fesa::DiagnosticUtils::setActionProfilingStr = "SetActionProfiling"
const std::string fesa::DiagnosticUtils::setActionTrackingStr = "SetActionTracking"
const std::string fesa::DiagnosticUtils::signalHandlerTrackingStr = "SignalHandlerTracking"
const std::string fesa::DiagnosticUtils::startUpTrackingStr = "StartUpTracking"
const std::string fesa::DiagnosticUtils::subscriptionTrackingStr = "SubscriptionTracking"
const std::string fesa::DiagnosticUtils::transactionTrackingStr = "TransactionTracking"
const std::string fesa::DiagnosticUtils::userDiagLoggerNamePrefix = "FESA.DIAG.USR."

Definition at line 18 of file DiagnosticUtils.h.


Generated on 18 Jan 2013 for Fesa by  doxygen 1.6.1