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

CosLwLog::LogProducer Interface Reference

import "CosLW_Log.idl";

Inheritance diagram for CosLwLog::LogProducer:

[legend]Collaboration diagram for CosLwLog::LogProducer:

[legend]List of all members.

---

Detailed Description

Clients use this interface to produce log messages

Public Member Functions
oneway void	write_records (in ProducerLogRecordSequence records)
oneway void	write_record (in ProducerLogRecord record)
unsigned long long	get_max_size ()
unsigned long long	get_current_size ()
unsigned long long	get_n_records ()
LogFullAction	get_log_full_action ()
AvailabilityStatus	get_availability_status ()
AdministrativeState	get_administrative_state ()
OperationalState	get_operational_state ()

---

Member Function Documentation

AdministrativeState CosLwLog::LogStatus::get_administrative_state (   )  [inherited]

Access the ability of this Log to accept new log records A Log can be LOCKED or UNLOCKED. If LOCKED no new records are accepted. Existing records can be read. Returns: The administratvie state of the Log

AvailabilityStatus CosLwLog::LogStatus::get_availability_status (   )  [inherited]

Access the Availability status for this Log The ability of the Log to accept and store messages can become impaired. This operation is used to check the status of a Log. AvailabiltyStatus contains two values: off_duty when true denotes the log is disabled log_full when true denotes that all free space is depleted Returns: Current availability status

unsigned long long CosLwLog::LogStatus::get_current_size (   )  [inherited]

The current size of the log storage area Obtain the current size in bytes of the log storage area. Invariant: size <= get_max_size() Returns: The current size in bytes of the log storage area

LogFullAction CosLwLog::LogStatus::get_log_full_action (   )  [inherited]

Access the Log Full Action configuration state LogFullAction denotes the action that the Log will take when the storage area is full. Possible values are HALT, if no futher logging records are accepted, and WRAP, if the log overwrites the oldest records in the storage area. Returns: The selected alternative of LogFullAction

unsigned long long CosLwLog::LogStatus::get_max_size (   )  [inherited]

Returns the size of the log storage area Obtain the maximum capacity in bytes of the storage area. Returns: long long

unsigned long long CosLwLog::LogStatus::get_n_records (   )  [inherited]

The current number of records in the storage area Obtain the number of records currently in the log storage area. Returns: The number of records currently stored in the Log

OperationalState CosLwLog::LogStatus::get_operational_state (   )  [inherited]

Access the operational status of the Log In a DISABLED state the Log has encountered a runtime problem and is not available to clients. In an ENABLED state the Log is available to all clients. Returns: The operational state of the Log

oneway void CosLwLog::LogProducer::write_record (  in ProducerLogRecord  record  )

Write a single record to the log Postcondition: The current UTC time is set on the time field of each record and unique ID is added to the id field of the Log Record Note: When there is insufficient space and LogFullAction == HALT the AvailabilityStatus.logFull state will be set to true

oneway void CosLwLog::LogProducer::write_records (  in ProducerLogRecordSequence  records  )

Write a set of records to the log Postcondition: The current UTC time is set on the time field of each record and unique ID is added to the id field of the Log Record Note: When there is insufficient space and LogFullAction == HALT the AvailabilityStatus.logFull state will be set to true

---

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

• CosLW_Log.idl

---