SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A body class for trace event client implementations. More...
#include <rw/trace/RWTraceEventClientImp.h>
Public Member Functions | |
virtual | ~RWTraceEventClientImp (void) |
void | connectToManager (void) |
void | connect (RWTraceEventFilter &filter) |
void | disconnect (void) |
void | trace (const RWTraceEvent &ev) |
void | addReference (void) |
unsigned | removeReference (void) |
Protected Member Functions | |
RWTraceEventClientImp (void) | |
virtual void | doTrace (const RWTraceEvent &ev)=0 |
RWMutex & | getMutex (void) |
RWTraceEventClientImp is a body class that provides an interface for trace event clients. Derived clients are required to implement this interface.
virtual RWTraceEventClientImp::~RWTraceEventClientImp | ( | void | ) | [virtual] |
Destructor.
RWTraceEventClientImp::RWTraceEventClientImp | ( | void | ) | [protected] |
Default constructor.
void RWTraceEventClientImp::addReference | ( | void | ) | [inline] |
Increments the reference count.
void RWTraceEventClientImp::connect | ( | RWTraceEventFilter & | filter | ) |
Connects the client with the filter.
If the client is already connected, throws the exception RWTraceClientAlreadyConnected.
void RWTraceEventClientImp::connectToManager | ( | void | ) |
Connects the client with the global singleton trace event manager. The manager allows a single client connection at a time.
If the client is already connected, throws the exception RWTraceClientAlreadyConnected. If the manager already has a client connected, throws the exception RWTraceClientAlreadyAdded.
void RWTraceEventClientImp::disconnect | ( | void | ) |
Disconnects the client from the filter it is currently attached to.
If the client is not connected, throws the exception RWTraceClientNotConnected.
virtual void RWTraceEventClientImp::doTrace | ( | const RWTraceEvent & | ev | ) | [protected, pure virtual] |
Processes a trace event. This method must be overridden by derived clients to provide a way to handle the trace event, perhaps by printing it to standard output or storing it in a file. See the discussion on the TraceEventClient in the Threads Module User's Guide.
Implemented in RWTraceLevelFilterImp, RWTraceMultiClientFilterImp, RWTraceOstreamClientImp, and RWTraceSingleClientFilterImp.
RWMutex & RWTraceEventClientImp::getMutex | ( | void | ) | [inline, protected] |
Returns the mutex used for thread-safety. The mutex can be used by derived clients.
unsigned RWTraceEventClientImp::removeReference | ( | void | ) | [inline] |
Decrements the reference count.
void RWTraceEventClientImp::trace | ( | const RWTraceEvent & | ev | ) |
Forwards trace information to the doTrace() member.
© 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.