RWTraceEventClientImp

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

RWTraceEventClientImp

Module: Threads Package: Execution Tracing


RWTraceEventClientImp   RWReference

Local Index
Header File
Description
Public Destructors
Public Member Functions
Protected Constructor
Protected Member Functions
See Also

Local Index

Members

addReference()
connect()
connectToManager()

disconnect()
doTrace()
getMutex()

removeReference()
RWTraceEventClientImp()
trace()

~RWTraceEventClientImp()

Header File

#include <rw/trace/RWTraceEventClientImp.h>

Description

TraceEventClientImp is a body class for trace event clients. This class provides the interface for clients.

Public Destructors

virtual 
~RWTraceEventClientImp();

Destructor.

Public Member Functions

void 
addReference();

Increments reference count. Uses a mutex for thread-safety.

void 
connect(RWTraceEventFilter& filter);

Connects the client with the filter passed as an argument. If the client is already connected, throws the exception RWTraceClientAlreadyConnected.

void 
connectToManager();

Connects the client with the global singleton trace event manager. If the client is already connected, throws the exception RWTraceClientAlreadyConnected. If the manager already has a client connected (there can be only one), it throws the exception RWTraceClientAlreadyAdded.

void 
disconnect();

Disconnects the client from the filter to which it is currently attached. If the client is not connected, throws the exception RWTraceClientNotConnected.

unsigned 
removeReference();

Decrements the reference count. Uses a mutex for thread-safety.

void 
trace(const RWTraceEvent& ev);

Forwards trace information to the doTrace() member.

Protected Constructor

RWTraceEventClientImp();

Default constructor.

Protected Member Functions

virtual void 
doTrace(const RWTraceEvent& ev) = 0;

Processes a trace event. Derived clients must define this method.

RWMutex& 
getMutex();

Returns the mutex used for thread-safety. The mutex can be used by derived clients.