SourcePro® 2024.1 |
SourcePro® API Reference Guide |
The handle to a singleton trace event manager implementation. More...
#include <rw/trace/RWTraceManager.h>
Static Public Member Functions | |
static void | disconnectClient (void) |
static RWTraceManager | instance (void) |
Additional Inherited Members | |
Protected Member Functions inherited from RWTraceEventClient | |
RWTraceEventClientImp * | getBody (void) const |
void | transfer (RWTraceEventClientImp *bodyP=0) |
RWTraceManager is the handle for the singleton trace event manager implementation, which accepts and forwards trace information to the connected client.
Attempts to add a client when there is one present already throw an exception.
If no client is connected, the manager buffers events. The maximum number of buffered events defaults to 100. If the maximum number of buffered events is reached, the oldest event is removed from the buffer to make room for the newest one.
To specify the buffer's size, use the environment variable RW_TRACE_BUFFER_SIZE
. Once a client is connected, the manager immediately forwards all buffered trace events, and buffering ceases. Buffering resumes when the client is disconnected.
To specify the minimum severity level for event generation, use the environment variable RW_TRACE_LEVEL
. The default severity level is INFO
. The environment variable can be set to one of the following: FATAL
, ERROR
, WARNING
, INFO
, TEST
, DEBUG
, ENTRY
, or NONE
.
The singleton trace event manager implementation is reference-counted to ensure that it will not be destroyed while a client is still connected to it.
RWTraceManager::RWTraceManager | ( | void | ) |
Default constructor. Always returns a handle whose body is the singleton trace event manager implementation.
RWTraceManager::RWTraceManager | ( | RWStaticCtor | ) |
Constructs a global static handle instance (that may be used before being constructed).
RWTraceManager::RWTraceManager | ( | const RWTraceManager & | second | ) |
Attaches to and increments the reference count on the body of second.
RWTraceManager::~RWTraceManager | ( | void | ) |
Destructor.
|
static |
Disconnects the client from the trace manager singleton.
|
inline |
Returns the trace manager's runtime severity level.
|
static |
Static method that returns a handle to the manager. Initialization is performed, if not already completed. This includes setting the maximum buffer size if the environment variable RW_TRACE_BUFFER_SIZE
has a positive numeric value.
|
inline |
Sets the trace manager's runtime severity level.
Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |