ball::Observer Class Reference

#include <ball_observer.h>

Inheritance diagram for ball::Observer:

Detailed Description

This class provides a protocol for receiving and processing log record output.

See ball_observer

Public Member Functions
virtual	~Observer ()
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 ()

Constructor & Destructor Documentation

~Observer()

virtual ball::Observer::~Observer ( )

virtual

Destroy this observer.

Member Function Documentation

publish() [1/2]

virtual void ball::Observer::publish ( const bsl::shared_ptr< const Record > &  record, const Context &  context  )

virtual

Process the specified log record having the specified publishing context. The exact definition of publish depends on the implementing class, though the intention is that the log record (whose publication has occurred according to context) be distributed in a human or machine readable form.

Reimplemented in ball::AsyncFileObserver, ball::BroadcastObserver, ball::CstdioObserver, ball::FilteringObserver, ball::StreamObserver, ball::AsyncFileObserver, ball::BroadcastObserver, ball::CstdioObserver, ball::FileObserver, ball::FileObserver2, ball::FilteringObserver, ball::MultiplexObserver, ball::ObserverAdapter, ball::StreamObserver, and ball::TestObserver.

publish() [2/2]

virtual void ball::Observer::publish ( const Record &  record, const Context &  context  )

virtual

Process the specified log record having the specified publishing context.

Deprecated:

Use the alternative publish overload instead.

Reimplemented in ball::AsyncFileObserver, ball::BroadcastObserver, ball::CstdioObserver, ball::FilteringObserver, ball::StreamObserver, ball::FileObserver, ball::FileObserver2, ball::MultiplexObserver, ball::TestObserver, and ball::ObserverAdapter.

releaseRecords()

virtual void ball::Observer::releaseRecords ( )

virtual

Discard any shared references to Record objects that were supplied to the publish method, and are held by this observer.

Note

Note that this operation should be called if resources underlying the previously provided shared pointers must be released.

Reimplemented in ball::AsyncFileObserver, ball::BroadcastObserver, ball::CstdioObserver, ball::FileObserver, ball::FileObserver2, ball::FilteringObserver, ball::MultiplexObserver, ball::ObserverAdapter, ball::StreamObserver, and ball::TestObserver.

---

The documentation for this class was generated from the following file:

• ball_observer.h