BoilerPlate-LightweightLogging Service OMG Formal/03-11-03

BPLog Class Reference
[LWLogging Producer Client]

#include <BPLog.h>

Inheritance diagram for BPLog:

[legend]Collaboration diagram for BPLog:

[legend]List of all members.

---

Detailed Description

The root superclass for all Log Producer Clients.

Author

knoxy

Revision

1.1

Date

2004/10/26 02:58:26

The root superclass for a Logging client. All client classes should declare a member of BPLog& type and assign BPLog::log() to the member. There are two stock implementations:

• BPLoggingStub - A writes to clog or file
• LWLoggingPostORBInitCommand - Connects to the LWLogging Service using the name service

Public Member Functions
virtual void	logSecurityAlarm (const char *producerId, const char *msg)=0
virtual void	logFailureAlarm (const char *producerId, const char *msg)=0
virtual void	logDegradedAlarm (const char *producerId, const char *msg)=0
virtual void	logExceptionError (const char *producerId, const char *msg)=0
virtual void	logFlowControlError (const char *producerId, const char *msg)=0
virtual void	logRangeError (const char *producerId, const char *msg)=0
virtual void	logUsageError (const char *producerId, const char *msg)=0
virtual void	logAdministrativeEvent (const char *producerId, const char *msg)=0
virtual void	logStatisticReport (const char *producerId, const char *msg)=0
virtual void	logDebugReport (const char *producerId, const char *msg, unsigned short debuglevel=10)=0
Static Public Member Functions
BPLog &	log ()
Protected Member Functions
void	log (BPLog *log)

---

Member Function Documentation

void BPLog::log (  BPLog *  log  )  [inline, protected]

Set the static Log pointer Used by the implementation to set the pointer to the Log Parameters: log  - The pointer to the Log implementation

BPLog& BPLog::log (   )  [inline, static]

Obtain the interface to the log Producer Clients obtain a reference to the Logging mechanism by calling BPLog::log(). Note: The reference is not valid until after the ORB has been initialized.

virtual void BPLog::logAdministrativeEvent (  const char *  producerId, const char *  msg )  [pure virtual]

Log an Administrative event An administrative event includes events like startup and shutdown. It also includes requests that change the application's configuration Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logDebugReport (  const char *  producerId, const char *  msg, unsigned short  debuglevel = 10 )  [pure virtual]

Log a debug message A general debugging hook. The debuglevel parm must be greater than 9. If the debug level is less than 10, the operation will add 10 to the inbound level Parameters: producerId  - the name of the producer msg  - The message to log debuglevel  - The debug level Invariant: debuglevel < 10 ? debuglevel += 10 debuglevel > 26 ? debuglevel = 26 Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logDegradedAlarm (  const char *  producerId, const char *  msg )  [pure virtual]

Log a Degraded Alarm A degraded alarm is raised when the system is in a state the inhibits it from performing at peak effeciency. For example, if the system can perform some of its functions but not all of its functions, it is in a degraded state. Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logExceptionError (  const char *  producerId, const char *  msg )  [pure virtual]

Log an Exception Error Use this operation to log exceptions as they are generated. Exceptions should be logged at points where they are generated, rethrown, or translated into new exception types. No information should be lost Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logFailureAlarm (  const char *  producerId, const char *  msg )  [pure virtual]

Log a Failure Alarm A Failure Alarm is raised when the application fails to create, find, or initialize an external service like a database connection, etc. Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logFlowControlError (  const char *  producerId, const char *  msg )  [pure virtual]

Log a Flow control error A flow control error occurs if a thread exhausts the control branches of a flow without falling into one of the branches. Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logRangeError (  const char *  producerId, const char *  msg )  [pure virtual]

Log a Range Error A Range Error occurs when a value is expected to be within a certain constraint but either exceeds or preceeds the range Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logSecurityAlarm (  const char *  producerId, const char *  msg )  [pure virtual]

Log a security alarm A security alarm is a notification that something has attempted to violate the application's security mechanism Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logStatisticReport (  const char *  producerId, const char *  msg )  [pure virtual]

Log a statistic report A statistic report includes messages about the applications performance and resources Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

virtual void BPLog::logUsageError (  const char *  producerId, const char *  msg )  [pure virtual]

Log a Usage Error Usage Errors include illegal argruments or arguments that would result in an illegal state Parameters: producerId  - the name of the producer msg  - The message to log Implemented in BPLoggingStub, and LWLoggingPostORBInitCommand.

---

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

• BPLog.h

---