Quick Links: |
#include <ball_testobserver.h>
Public Member Functions | |
BSLMF_NESTED_TRAIT_DECLARATION (TestObserver, bslma::UsesBslmaAllocator) | |
TestObserver (bsl::ostream *stream, bslma::Allocator *basicAllocator=0) | |
TestObserver (bsl::ostream &stream, bslma::Allocator *basicAllocator=0) | |
virtual | ~TestObserver () |
virtual void | publish (const Record &record, const Context &context) |
virtual void | publish (const bsl::shared_ptr< const Record > &record, const Context &context) |
virtual void | releaseRecords () |
void | setVerbose (int flagValue) |
int | id () const |
const Context & | lastPublishedContext () const |
const Record & | lastPublishedRecord () const |
int | numPublishedRecords () const |
int | numReleases () const |
Static Public Member Functions | |
static int | numInstances () |
This class provides an instrumented implementation of the Observer
protocol suitable for testing systems that use Observer
. Each instance receives a unique (per process) integer identifier at construction, and keeps count of the number of records that it has published, as well as the contents of the most recently published record and context.
By default, the publish
method prints no diagnostic information to the bsl::ostream
supplied at construction. This diagnostic information can be enabled by a call to setVerbose
with a non-zero argument. A subsequent call to setVerbose
with a zero argument will restore the default behavior of publish
.
See Component ball_testobserver
ball::TestObserver::TestObserver | ( | bsl::ostream * | stream, | |
bslma::Allocator * | basicAllocator = 0 | |||
) | [explicit] |
Create a test observer having a unique integer identifier, whose publish
method will print diagnostic information (if any) to the specified stream
. Optionally specify a basicAllocator
used to supply memory. If basicAllocator
is 0, the currently installed default allocator is used. By default, this observer prints nothing to stream
. Note that the setVerbose
method can affect this default behavior.
ball::TestObserver::TestObserver | ( | bsl::ostream & | stream, | |
bslma::Allocator * | basicAllocator = 0 | |||
) | [explicit] |
Create a test observer having a unique integer identifier, whose publish
method will print diagnostic information (if any) to the specified stream
. Optionally specify a basicAllocator
used to supply memory. If basicAllocator
is 0, the currently installed default allocator is used. By default, this observer prints nothing to stream
. Note that the setVerbose
method can affect this default behavior.
DEPRECATED: Use the constructor taking bsl::ostream *
instead.
virtual ball::TestObserver::~TestObserver | ( | ) | [virtual] |
Destroy this test observer.
ball::TestObserver::BSLMF_NESTED_TRAIT_DECLARATION | ( | TestObserver | , | |
bslma::UsesBslmaAllocator | ||||
) |
static int ball::TestObserver::numInstances | ( | ) | [static] |
Return the total number of instances of this class that have been created since this process has begun.
virtual void ball::TestObserver::publish | ( | const Record & | record, | |
const Context & | context | |||
) | [virtual] |
Store as the most recently published data the specified log record
and publishing context
. If this test observer is in verbose mode, print an appropriate diagnostic message to the stream specified at construction. Note that at construction test observers are not in verbose mode, but that the setVerbose
method can affect this mode, and thus the behavior of this method.
DEPRECATED: Use the alternative publish
overload instead.
Reimplemented from ball::Observer.
virtual void ball::TestObserver::publish | ( | const bsl::shared_ptr< const Record > & | record, | |
const Context & | context | |||
) | [virtual] |
Store as the most recently published data the specified log record
and publishing context
. If this test observer is in verbose mode, print an appropriate diagnostic message to the stream specified at construction. Note that at construction test observers are not in verbose mode, but that the setVerbose
method can affect this mode, and thus the behavior of this method.
Reimplemented from ball::Observer.
virtual void ball::TestObserver::releaseRecords | ( | ) | [virtual] |
Discard any shared reference to a Record
object that was supplied to the publish
method, and is held by this observer. Note that this operation should be called if resources underlying the previously provided shared-pointers must be released.
Reimplemented from ball::Observer.
void ball::TestObserver::setVerbose | ( | int | flagValue | ) |
Set the internal verbose mode of this test observer to the specified (boolean) flagValue
. The default mode is not verbose. If flagValue
is non-zero, calls to publish
will print appropriate diagnostics to the bsl::ostream
associated with this test observer. This printing is suppressed if flagValue
is 0.
int ball::TestObserver::id | ( | ) | const |
Return the unique (per process) integer identifier of this test observer.
const Context& ball::TestObserver::lastPublishedContext | ( | ) | const |
Return a reference to the context most recently published by this test observer. The behavior is undefined unless publish
has been called at least once, and no other thread is manipulating this object concurrently (i.e., this function is not thread safe).
const Record& ball::TestObserver::lastPublishedRecord | ( | ) | const |
Return a reference to the record most recently published by this test observer. The behavior is undefined unless publish
has been called at least once, and no other thread is manipulating this object concurrently (i.e., this function is not thread safe).
int ball::TestObserver::numPublishedRecords | ( | ) | const |
Return the total number of records that this test observer has published.
int ball::TestObserver::numReleases | ( | ) | const |
Return the total number of times that releaseRecords
has been called on this test observer.