RWTraceEventClientImp Class Reference

A body class for trace event client implementations. More...

#include <rw/trace/RWTraceEventClientImp.h>

Inheritance diagram for RWTraceEventClientImp:

Public Member Functions
virtual	~RWTraceEventClientImp (void)
void	addReference (void)
void	connect (RWTraceEventFilter &filter)
void	connectToManager (void)
void	disconnect (void)
unsigned	removeReference (void)
void	trace (const RWTraceEvent &ev)

Protected Member Functions
	RWTraceEventClientImp (void)
virtual void	doTrace (const RWTraceEvent &ev)=0
RWMutex &	getMutex (void)

Detailed Description

RWTraceEventClientImp is a body class that provides an interface for trace event clients. Derived clients are required to implement this interface.

See also

RWTraceEventClient, RWTraceEventFilter, RWTraceManager

Constructor & Destructor Documentation

~RWTraceEventClientImp()

virtual RWTraceEventClientImp::~RWTraceEventClientImp ( void )

virtual

Destructor.

RWTraceEventClientImp()

RWTraceEventClientImp::RWTraceEventClientImp ( void )

protected

Default constructor.

Member Function Documentation

addReference()

void RWTraceEventClientImp::addReference ( void )

inline

Increments the reference count.

connect()

void RWTraceEventClientImp::connect

(

RWTraceEventFilter &

filter

)

Connects the client with the filter.

If the client is already connected, throws the exception RWTraceClientAlreadyConnected.

connectToManager()

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.

disconnect()

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.

doTrace()

virtual void RWTraceEventClientImp::doTrace ( const RWTraceEvent & ev )

protectedpure 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.

getMutex()

RWMutex & RWTraceEventClientImp::getMutex ( void )

inlineprotected

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

removeReference()

unsigned RWTraceEventClientImp::removeReference ( void )

inline

Decrements the reference count.

trace()

void RWTraceEventClientImp::trace

(

const RWTraceEvent &

ev

)

Forwards trace information to the doTrace() member.