|
version 1.6, 2002/03/09 01:17:10
|
version 1.10, 2002/06/03 19:32:35
|
|
|
|
| //%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| // | // |
| // Copyright (c) 2000, 2001 BMC Software, Hewlett-Packard Company, IBM, |
// Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM, |
| // The Open Group, Tivoli Systems | // The Open Group, Tivoli Systems |
| // | // |
| // Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
|
|
|
| #include <Pegasus/Common/TraceComponents.h> | #include <Pegasus/Common/TraceComponents.h> |
| #include <Pegasus/Common/TraceFileHandler.h> | #include <Pegasus/Common/TraceFileHandler.h> |
| | |
| // REVIEW: Ask how this all works (note to myself)? |
|
| |
|
| PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| | |
| /** Tracer implements tracing of messages to a defined file | /** Tracer implements tracing of messages to a defined file |
|
|
|
| const char* methodName) | const char* methodName) |
| { | { |
| _traceEnter( fileName, lineNum, traceComponent, "%s %s", | _traceEnter( fileName, lineNum, traceComponent, "%s %s", |
| _FUNC_ENTER_MSG, methodName); |
_METHOD_ENTER_MSG, methodName); |
| } | } |
| | |
| /** Traces method exit. | /** Traces method exit. |
|
|
|
| const char* methodName) | const char* methodName) |
| { | { |
| _traceExit( fileName, lineNum, traceComponent, "%s %s", | _traceExit( fileName, lineNum, traceComponent, "%s %s", |
| _FUNC_EXIT_MSG, methodName); |
_METHOD_EXIT_MSG, methodName); |
| } | } |
| | |
| /** Validates the File Path for the trace File | /** Validates the File Path for the trace File |
|
|
|
| @return 1 if the file path is valid | @return 1 if the file path is valid |
| 0 if the file path is invalid | 0 if the file path is invalid |
| */ | */ |
| static Boolean isValid(const char* filePath); |
static Boolean isValidFileName(const char* filePath); |
| |
|
| |
/** Validates the trace components |
| |
@param traceComponents comma separated list of trace components |
| |
@return 1 if the components are valid |
| |
0 if one or more components are invalid |
| |
*/ |
| |
static Boolean isValidComponents(const String traceComponents); |
| | |
| /** Validates the trace components | /** Validates the trace components |
| @param traceComponents comma separated list of trace components | @param traceComponents comma separated list of trace components |
|
|
|
| @return 1 if the components are valid | @return 1 if the components are valid |
| 0 if one or more components are invalid | 0 if one or more components are invalid |
| */ | */ |
| static Boolean isValid( |
static Boolean isValidComponents( |
| const String traceComponents, String& invalidComponents=_EMPTY_STRING); |
const String traceComponents, |
| |
String& invalidComponents); |
| | |
| private: | private: |
| | |
|
|
|
| static const Uint32 _STRLEN_MAX_PID_TID; | static const Uint32 _STRLEN_MAX_PID_TID; |
| static const Boolean _SUCCESS; | static const Boolean _SUCCESS; |
| static const Boolean _FAILURE; | static const Boolean _FAILURE; |
| static String _EMPTY_STRING; |
|
| Boolean* _traceComponentMask; | Boolean* _traceComponentMask; |
| Uint32 _traceLevelMask; | Uint32 _traceLevelMask; |
| TraceFileHandler* _traceHandler; | TraceFileHandler* _traceHandler; |
| static Tracer* _tracerInstance; | static Tracer* _tracerInstance; |
| | |
| // Message Strings for fucntion Entry and Exit |
// Message Strings for function Entry and Exit |
| static const char _FUNC_ENTER_MSG[]; |
static const char _METHOD_ENTER_MSG[]; |
| static const char _FUNC_EXIT_MSG[]; |
static const char _METHOD_EXIT_MSG[]; |
| | |
| // Message Strings for Logger | // Message Strings for Logger |
| static const char _LOG_MSG[]; | static const char _LOG_MSG[]; |
|
|
|
| | |
| // Define the macros for method entry/exit, and tracing a given string | // Define the macros for method entry/exit, and tracing a given string |
| #ifdef PEGASUS_REMOVE_TRACE | #ifdef PEGASUS_REMOVE_TRACE |
| #define PEG_FUNC_ENTER(traceComponent,methodName) |
|
| #define PEG_FUNC_EXIT(traceComponent,methodName) |
|
| #define PEG_METHOD_ENTER(traceComponent,methodName) | #define PEG_METHOD_ENTER(traceComponent,methodName) |
| #define PEG_METHOD_EXIT() | #define PEG_METHOD_EXIT() |
| #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString) | #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString) |
| #else | #else |
| /** Macro for tracing method entry | /** Macro for tracing method entry |
| ATTN: Phase out in favor of PEG_METHOD_ENTER |
|
| @param traceComponent component being traced |
|
| @param methodName name of the method |
|
| */ |
|
| #define PEG_FUNC_ENTER(traceComponent,methodName) \ |
|
| Tracer::traceEnter(__FILE__, __LINE__,traceComponent,methodName) |
|
| |
|
| /** Macro for tracing method exit |
|
| ATTN: Phase out in favor of PEG_METHOD_EXIT |
|
| @param traceComponent component being traced |
|
| @param methodName name of the method |
|
| */ |
|
| #define PEG_FUNC_EXIT(traceComponent,methodName) \ |
|
| Tracer::traceExit(__FILE__,__LINE__,traceComponent,methodName) |
|
| |
|
| /** Macro for tracing method entry |
|
| @param traceComponent component being traced | @param traceComponent component being traced |
| @param methodName name of the method | @param methodName name of the method |
| */ | */ |
|
|
|
| */ | */ |
| #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString) \ | #define PEG_TRACE_STRING(traceComponent,traceLevel,traceString) \ |
| Tracer::trace(__FILE__, __LINE__,traceComponent,traceLevel,traceString) | Tracer::trace(__FILE__, __LINE__,traceComponent,traceLevel,traceString) |
| |
|
| #endif | #endif |
| | |
| PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
Return to
Tracer.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Common