SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWTraceSingleClientFilterImp Class Reference

A body class for a trace level filter that accepts only one client. More...

#include <rw/trace/RWTraceSingleClientFilterImp.h>

Inheritance diagram for RWTraceSingleClientFilterImp:
RWTraceEventFilterImp RWTraceEventClientImp RWTraceLevelFilterImp

Public Member Functions

virtual ~RWTraceSingleClientFilterImp (void)
 
void disconnectClient (void)
 
- Public Member Functions inherited from RWTraceEventFilterImp
virtual ~RWTraceEventFilterImp (void)
 
void add (RWTraceEventClientImp *clientP)
 
void remove (RWTraceEventClientImp *clientP)
 
- Public Member Functions inherited from RWTraceEventClientImp
virtual ~RWTraceEventClientImp (void)
 
void addReference (void)
 
void connect (RWTraceEventFilter &filter)
 
void connectToManager (void)
 
void disconnect (void)
 
unsigned removeReference (void)
 
void trace (const RWTraceEvent &ev)
 

Static Public Member Functions

static RWTraceSingleClientFilter make (void)
 

Protected Member Functions

 RWTraceSingleClientFilterImp (void)
 
virtual void doAdd (RWTraceEventClientImp *clientP)
 
virtual void doDisconnectClient ()
 
virtual void doRemove (RWTraceEventClientImp *clientP)
 
virtual void doTrace (const RWTraceEvent &ev)
 
RWTraceEventClientImpgetClient ()
 
- Protected Member Functions inherited from RWTraceEventFilterImp
 RWTraceEventFilterImp (void)
 
- Protected Member Functions inherited from RWTraceEventClientImp
 RWTraceEventClientImp (void)
 
RWMutex & getMutex (void)
 

Detailed Description

RWTraceSingleClientFilterImp is a filter implementation that accepts one client to which it forwards trace events. This class is intended to be the base class for filters that accept one client and is not intended to be directly instantiated.

Attempting to add a client if the filter already has one throws an RWTraceClientAlreadyAdded exception.

See also
RWTraceSingleClientFilter, RWTraceMultiClientFilterImp

Constructor & Destructor Documentation

◆ ~RWTraceSingleClientFilterImp()

virtual RWTraceSingleClientFilterImp::~RWTraceSingleClientFilterImp ( void )
virtual

Destructor.

◆ RWTraceSingleClientFilterImp()

RWTraceSingleClientFilterImp::RWTraceSingleClientFilterImp ( void )
protected

Default constructor.

Member Function Documentation

◆ disconnectClient()

void RWTraceSingleClientFilterImp::disconnectClient ( void )

Disconnects the attached client.

◆ doAdd()

virtual void RWTraceSingleClientFilterImp::doAdd ( RWTraceEventClientImp * clientP)
protectedvirtual

Attaches a client to the filter. Throws an exception if there already is a client.

Implements RWTraceEventFilterImp.

◆ doDisconnectClient()

virtual void RWTraceSingleClientFilterImp::doDisconnectClient ( )
protectedvirtual

Disconnects the attached client.

◆ doRemove()

virtual void RWTraceSingleClientFilterImp::doRemove ( RWTraceEventClientImp * clientP)
protectedvirtual

Detaches the client.

Implements RWTraceEventFilterImp.

◆ doTrace()

virtual void RWTraceSingleClientFilterImp::doTrace ( const RWTraceEvent & ev)
protectedvirtual

Forwards the trace event to the attached client.

Implements RWTraceEventClientImp.

Reimplemented in RWTraceLevelFilterImp.

◆ getClient()

RWTraceEventClientImp * RWTraceSingleClientFilterImp::getClient ( )
inlineprotected

Returns a pointer to the attached client.

◆ make()

static RWTraceSingleClientFilter RWTraceSingleClientFilterImp::make ( void )
static

Creates a new RWTraceSingleClientFilterImp instance.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.