The MTrace class sets up and maintains a
trace mapping table, the data structure that holds the mapping between a message and the corresponding list of message destinations (sinks). Messages are defined by role.
Predefined Roles
Predefined roles are:
- MAPP_ERROR_ROLE: unrecoverable Exceptions. This operation is skipped and the component might continue with the next operation or might stop altogether
- MAPP_WARN_ROLE: an abnormal condition was found. It does not prevent processing but special attention from an administrator is recommended.
- MAPP_INFO_ROLE: a significant processing step was reached. It is logged for tracking/auditing purposes. See the remarks section of MTrace::debug() for a discussion of tracing significant steps.
- MAPP_DEBUG_ROLE: developer defined tracing. During normal operation, DEBUG should be turned off.
- Custom Defined Roles: These can be used to add targeted detailed tracing information which can be turned on/off independently. All additional custom roles must be for debug purposes and are turned off in normal operation.
The MTrace class provides methods that allow applications to send traces to a sink. A sink can be a file, a TIBCO Rendezvous session, or some other application-defined destination. Each
trace contains a time stamp, the applicationId, and the user-defined
trace message.
Deprecated Methods
void debug(const char* pchMsgFormatString, ... );
void debug(const MString& rsMessage );
void debug(const MTree& rmTree);
void error(const char* pchMsgFormatString, ... );
void error(const MString& rsMessage );
void error(const MTree& rmTree);
void info(const char* pchMsgFormatString, ... );
void info(const MString& rsMessage );
void info(const MTree& rmTree);
virtual void trace( const MString& rsRole,
const char* pchMsgFormatString, ... );
virtual void trace( const MString& rsRole, const MString& rsMessage );
virtual void trace( const MString& rsRole, const MTree& rmTree);
void warn(const char* pchMsgFormatString, ... );
void warn(const MString& rsMessage );
void warn(const MTree& rmTree);
virtual void vtrace( const MString& rsRole,
const char* pchMsgFormatString, va_list pArgList);