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

LogAdministrator_Impl Class Reference
[LWLogging Service]

#include <LogAdministrator_Impl.h>

Collaboration diagram for LogAdministrator_Impl:

[legend]List of all members.

---

Detailed Description

The servant implementation of CosLwLog::LogAdministrator.

Author

knoxy

Revision

1.3

Date

2004/10/24 01:35:54

Public Member Functions
	LogAdministrator_Impl (LogState &log_state, CORBA::ORB_ptr orb)
	Create the servant with a LogState.
virtual	~LogAdministrator_Impl ()
	dtor
virtual void	set_max_size (CORBA::ULongLong size) throw (CosLwLog::InvalidParam, CORBA::SystemException)
virtual void	set_log_full_action (CosLwLog::LogFullAction action) throw (CORBA::SystemException)
virtual void	set_administrative_state (CosLwLog::AdministrativeState state) throw (CORBA::SystemException)
virtual void	clear_log () throw (CORBA::SystemException)
virtual void	destroy () throw (CORBA::SystemException)
virtual CORBA::ULongLong	get_max_size () throw (CORBA::SystemException)
	Access the maximum size of the log.
virtual CORBA::ULongLong	get_current_size () throw (CORBA::SystemException)
	Access the maximum size of the log.
virtual CORBA::ULongLong	get_n_records () throw (CORBA::SystemException)
	Access the maximum size of the log.
virtual CosLwLog::LogFullAction	get_log_full_action () throw (CORBA::SystemException)
	Access the maximum size of the log.
virtual CosLwLog::AvailabilityStatus	get_availability_status () throw (CORBA::SystemException)
	Access the maximum size of the log.
virtual CosLwLog::AdministrativeState	get_administrative_state () throw (CORBA::SystemException)
	Access the maximum size of the log.
virtual CosLwLog::OperationalState	get_operational_state () throw (CORBA::SystemException)
	Access the maximum size of the log.

---

Constructor & Destructor Documentation

LogAdministrator_Impl::LogAdministrator_Impl (  LogState &  log_state, CORBA::ORB_ptr  orb )

Create the servant with a LogState.

virtual LogAdministrator_Impl::~LogAdministrator_Impl (   )  [virtual]

dtor

---

Member Function Documentation

virtual void LogAdministrator_Impl::clear_log (   )  throw (CORBA::SystemException) [virtual]

Clear this Log Instance Move the current open log to an archive and start a new Log Exceptions: CORBA::SystemException

virtual void LogAdministrator_Impl::destroy (   )  throw (CORBA::SystemException) [virtual]

Stop the Log Service Stop this instance of the Logging Service. This operation will not destroy the log files or archives. The routine calls LogState::destroyLog which changes the Log's administrative state to locked. Exceptions: CORBA::SystemException

virtual CosLwLog::AdministrativeState LogAdministrator_Impl::get_administrative_state (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current AdministrativeState of the Log Exceptions: CORBA::SystemException

virtual CosLwLog::AvailabilityStatus LogAdministrator_Impl::get_availability_status (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current AvailabilityStatus of the Log Exceptions: CORBA::SystemException

virtual CORBA::ULongLong LogAdministrator_Impl::get_current_size (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current size of the log in bytes Exceptions: CORBA::SystemException

virtual CosLwLog::LogFullAction LogAdministrator_Impl::get_log_full_action (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current LogFullAction Exceptions: CORBA::SystemException

virtual CORBA::ULongLong LogAdministrator_Impl::get_max_size (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current maximum size Exceptions: CORBA::SystemException

virtual CORBA::ULongLong LogAdministrator_Impl::get_n_records (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current number of LogRecords in the currenlty active Log file. Note: The total number of LogRecords does not include the Records in the Log archives Exceptions: CORBA::SystemException

virtual CosLwLog::OperationalState LogAdministrator_Impl::get_operational_state (   )  throw (CORBA::SystemException) [virtual]

Access the maximum size of the log. Returns: The current OperationalState of the Log Exceptions: CORBA::SystemException

virtual void LogAdministrator_Impl::set_administrative_state (  CosLwLog::AdministrativeState  state  )  throw (CORBA::SystemException) [virtual]

Set the Administrative State of the Log A Log can be locked or unlocked by an Administrator Parameters: state  - The new administrative state Exceptions: CORBA::SystemException

virtual void LogAdministrator_Impl::set_log_full_action (  CosLwLog::LogFullAction  action  )  throw (CORBA::SystemException) [virtual]

Set the action to take when the Log is full A log can take one of two actions HALT and WRAP Parameters: action  - The new LogFullAction Exceptions: CORBA::SystemException

virtual void LogAdministrator_Impl::set_max_size (  CORBA::ULongLong  size  )  throw (CosLwLog::InvalidParam, CORBA::SystemException) [virtual]

Set the maximum size of the log Parameters: size  - The new size Exceptions: InvalidParam  if the size is invalid. 0 is an invalid size CORBA::SystemException

---

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

• LogAdministrator_Impl.h

---