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

CosLwLog::LogAdministrator Interface Reference

import "CosLW_Log.idl";

Inheritance diagram for CosLwLog::LogAdministrator:

[legend]Collaboration diagram for CosLwLog::LogAdministrator:

[legend]List of all members.

---

Detailed Description

Provides administration for a Log

Public Member Functions
void	set_max_size (in unsigned long long size) raises (InvalidParam)
void	set_log_full_action (in LogFullAction action)
void	set_administrative_state (in AdministrativeState state)
void	clear_log ()
void	destroy ()
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

void CosLwLog::LogAdministrator::clear_log (   )

Purge the storage area This operation will purge all records from the storage aread. Subsequent calls to getCurrentSize will return zero

void CosLwLog::LogAdministrator::destroy (   )

Tears down an instantiated Log This operation will destroy a Log instance. All records are irrecoverably lost and memory resources are released

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

void CosLwLog::LogAdministrator::set_administrative_state (  in AdministrativeState  state  )

Configure the administrative state Affects the ability of the service to accept and store new Log Records. LOCKED will prohibit new LogRecords from being accepted. UNLOCKED allows new records to be accepted. This state does not affect reading of existing records. Remarks: AdministrativeState.LOCKED or UNLOCKED

void CosLwLog::LogAdministrator::set_log_full_action (  in LogFullAction  action  )

Configure the action to be taken if the storage area becomes full The Service will take this action when free space is depleted Parameters: action  HALT or WRAP. If HALT, no further records will be accepted. If WRAP the Log will begin to overwrite the oldest records

void CosLwLog::LogAdministrator::set_max_size (  in unsigned long long  size  )  raises (InvalidParam)

Sets the maximum size of the Log storage area Set the maximum capacity in bytes of the Log storage area Note: This operation is constrained by the underlying implementation Parameters: size  - The maximum size in bytes Exceptions: InvalidParam  if size is invalid

---

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

• CosLW_Log.idl

---