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

CosLwLog Namespace Reference

---

Detailed Description

The namespace for all LWL CORBA members.

Classes
struct	CosLwLog::LogTime
struct	CosLwLog::AvailabilityStatus
struct	CosLwLog::ProducerLogRecord
struct	CosLwLog::LogRecord
exception	CosLwLog::InvalidParam
	Denotes an invalid parameter has been passed to the Log. More...
interface	CosLwLog::LogStatus
interface	CosLwLog::LogConsumer
interface	CosLwLog::LogProducer
interface	CosLwLog::LogAdministrator
Typedefs
typedef unsigned short	LogLevel
	Use this typedef to define your Debug LogLevel-s.
typedef unsigned long long	RecordId
	Provides a unique ID for a LogRecord.
typedef sequence< LogRecord >	LogRecordSequence
	Unbounded sequence of LogRecords.
typedef sequence< ProducerLogRecord >	ProducerLogRecordSequence
	Unbounded sequence of ProducerLogRecords.
typedef sequence< LogLevel >	LogLevelSequence
	Unbounded sequence of LogLevel.
typedef sequence< string >	StringSeq
	Unbounded sequence of string.
Enumerations
enum	OperationalState { disabled, enabled }
enum	AdministrativeState { locked, unlocked }
enum	LogFullAction { WRAP, HALT }
Variables
const LogLevel	SECURITY_ALARM = 1
	Denotes a security infraction.
const LogLevel	FAILURE_ALARM = 2
	The system has failed to initialize a required resource.
const LogLevel	DEGRADED_ALARM = 3
	The system is in a degraded state.
const LogLevel	EXCEPTION_ERROR = 4
	An exception has occured or an error condition exists.
const LogLevel	FLOW_CONTROL_ERROR = 5
	A conditional has exhausted all branches and was not satisfied.
const LogLevel	RANGE_ERROR = 6
	Occurs when a value exceeds an expected range.
const LogLevel	USAGE_ERROR = 7
	Marks an illegal argument or an illegal state.
const LogLevel	ADMINISTRATIVE_EVENT = 8
	Includes startup, shutdown or runtime configuration changes.
const LogLevel	STATISTIC_REPORT = 9
	Report system statistics.

---

Typedef Documentation

typedef sequence<LogLevel> CosLwLog::LogLevelSequence

Unbounded sequence of LogLevel.

typedef sequence<LogRecord> CosLwLog::LogRecordSequence

Unbounded sequence of LogRecords.

typedef sequence<ProducerLogRecord> CosLwLog::ProducerLogRecordSequence

Unbounded sequence of ProducerLogRecords.

typedef unsigned long long CosLwLog::RecordId

Provides a unique ID for a LogRecord.

typedef sequence<string> CosLwLog::StringSeq

Unbounded sequence of string.

---

Enumeration Type Documentation

enum CosLwLog::AdministrativeState

AdministrativeState denotes the active logging state The AdministrativeState is set using the Administrator interface. unlocked: The Log will not accept producer messages. The Log can be read and deleted. locked: The Log will accept producer messages

enum CosLwLog::LogFullAction

Specifies what to do when the Log is full WRAP indicates thatthe Log will overwrite the oldest LogRecords. HALT indicates that the Log wil stop logging when full and put itself in a disabled OperationalState

enum CosLwLog::OperationalState

OperationalState defines the Log's current runtime state The Log has runtime state as well as AdminstrativeState. OperationalState can be set by the Log itself if it becomes unusable due to runtime errors, or if the LogFullAction is HALT and the Log has reached its maximum size. enabled: The Log is fully functional disabled: The Log is disabled and is not available to producers or consumers. The Log is available to the Administrator only when it is in this state.

---