Execution Tracing Package

Threads Module Reference Guide
Rogue Wave web site: Home Page | Main Documentation Page

2.3 Execution Tracing Package

For complete information about the Execution Tracing package, see Chapter 2 of the Threads Module User's Guide.

2.3.1 Execution Tracing Class Hierarchy

Figure 1: Trace class hierarchy

2.3.2 Index of Classes

Table 1 contains an alphabetical listing of the classes and global macros in the Execution Tracing package.

Table 1: Index of Execution Tracing classes

Class Name	Description
*RWTraceEventClient*	Handle for trace event client implementations.
*RWTraceEventClientImp*	Body for trace event clients. Provides interface for clients.
*RWTraceEventFilter*	Handle for trace event filter implementation.
*RWTraceEventFilterImp*	Body for trace event filters. Provides interface for adding and removing clients. Derived filters are required to implement this interface.
*RWTraceLevelFilter*	Single-client filter that lets only events of the supplied severity or higher pass through.
*RWTraceLevelFilterImp*	Implementation (body) for *RWTraceLevelFilter*.
*RWTraceManager*	Handle for the singleton trace event manager implementation that accepts and forwards trace information to the connected client.
*RWTraceMultiClientFilter*	Filter that accepts multiple clients and forwards trace events to them.
*RWTraceMultiClientFilterImp*	Filter implementation that accepts multiple clients and forwards trace events to them. Objects of this class should be instantiated through the corresponding handle class *RWTraceMultiClientFilter*.
*RWTraceOstreamClient*	Trace client that sends all events to an *std::ostream. If no ostream* is specified, uses `cerr` by default.
*RWTraceOstreamClientImp*	Implementation (body) for *RWTraceOstreamClient*.
*RWTraceSingleClientFilter*	Handle for filter implementation that accepts one client and forwards trace events to it.
*RWTraceSingleClientFilterImp*	Filter implementation that accepts one client and forwards trace events to it. This class is intended to be the base class for filters that accept one client. It is not meant to be instantiated as it provides no functionality.
`RW_STREAM_TO_STRING()`	Global macro for streaming objects into a trace macro's `message` parameter.
*RWTraceEventSeverity*	Contains tracing severity levels; provides basis for convenience macros.
Trace Set Declaration Macros	Global macros that implement the runtime lookup of environment variables that determine whether a function will generate a trace event. Set declaration macros come in three varieties: package declaration macros, class declaration macros, and function declaration macros.
Trace Event Generation Macros	Global macros that come in two forms, one for use within the member functions of classes and the other for use within static member, global functions and friend functions.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.