SourcePro® 2023.1 |
SourcePro® API Reference Guide |
A handle class for trace event client implementations. More...
#include <rw/trace/RWTraceEventClient.h>
Public Member Functions | |
RWTraceEventClient () | |
RWTraceEventClient (RWTraceEventClientImp *bodyP) | |
RWTraceEventClient (RWStaticCtor) | |
RWTraceEventClient (const RWTraceEventClient &second) | |
virtual | ~RWTraceEventClient (void) |
void | connect (RWTraceEventFilter &filter) |
void | connectToManager (void) |
void | disconnect (void) |
bool | isValid (void) const |
bool | operator!= (const RWTraceEventClient &second) const |
RWTraceEventClient & | operator= (const RWTraceEventClient &second) |
RWTraceEventClient & | operator= (RWTraceEventClientImp *ptr) |
bool | operator== (const RWTraceEventClient &second) const |
void | orphan (void) |
void | trace (const RWTraceEvent &ev) |
void | validate (void) const |
Protected Member Functions | |
RWTraceEventClientImp * | getBody (void) const |
void | transfer (RWTraceEventClientImp *bodyP=0) |
RWTraceEventClient is the handle for trace event client implementations, forwarding messages to its body for processing. A client must be connected to a filter (or the global trace manager) to receive trace messages. The filter calls the trace() method each time a trace event is generated.
RWTraceEventClient::RWTraceEventClient | ( | ) |
Creates an unattached handle.
RWTraceEventClient::RWTraceEventClient | ( | RWTraceEventClientImp * | bodyP | ) |
Attaches to and increments the reference count on bodyP.
RWTraceEventClient::RWTraceEventClient | ( | RWStaticCtor | ) |
Constructs a global static handle instance (that may be used before being constructed).
RWTraceEventClient::RWTraceEventClient | ( | const RWTraceEventClient & | second | ) |
Attaches to and increments the reference count on the body of second.
|
virtual |
Destructor.
void RWTraceEventClient::connect | ( | RWTraceEventFilter & | filter | ) |
Connects the client with the filter.
If the client is already connected, throws the exception RWTraceClientAlreadyConnected.
void RWTraceEventClient::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 RWTraceEventClient::disconnect | ( | void | ) |
Disconnects the client from the filter it is currently attached to.
If the client is not connected, throws the exception RWTraceClientNotConnected.
|
protected |
Returns a pointer to the associated body.
If the pointer is not associated with a body, throws RWTraceInvalidPointer.
bool RWTraceEventClient::isValid | ( | void | ) | const |
Returns true
if this handle is connected to a body, otherwise false
.
bool RWTraceEventClient::operator!= | ( | const RWTraceEventClient & | second | ) | const |
Returns true
if this instance points to a body other than the second instance.
RWTraceEventClient& RWTraceEventClient::operator= | ( | const RWTraceEventClient & | second | ) |
Detaches from the current body (if any), decrements its reference count, deletes it if there are no other references, and then attaches to the body of second and increments its reference count.
RWTraceEventClient& RWTraceEventClient::operator= | ( | RWTraceEventClientImp * | ptr | ) |
Detaches from the current body (if any), decrements its reference count, deletes it if there are no other references, and then attaches to the body ptr and increments its reference count.
bool RWTraceEventClient::operator== | ( | const RWTraceEventClient & | second | ) | const |
Returns true
if this instance points to the same body as the second instance.
void RWTraceEventClient::orphan | ( | void | ) |
Detaches from the current body (if any), decrements its reference count, and deletes it if there are no other references.
void RWTraceEventClient::trace | ( | const RWTraceEvent & | ev | ) |
Accepts a trace event.
|
protected |
Associates this handle with the body pointed to by bodyP and increments its reference count.
If this handle is already associated with a body, detaches from that body, decrements its reference count, and deletes it if there are no other references.
void RWTraceEventClient::validate | ( | void | ) | const |
Tests that this handle is associated with a body. If not, throws RWTraceInvalidPointer.
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |