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

CosLW_Log.idl

Go to the documentation of this file.

#ifndef MODULE_COS_LW_LOG_IDL 
#define MODULE_COS_LW_LOG_IDL

#pragma prefix "omg.org" 

   module CosLwLog {

      typedef unsigned short LogLevel;


      const LogLevel SECURITY_ALARM = 1;
      
      const LogLevel FAILURE_ALARM = 2; 
      
      const LogLevel DEGRADED_ALARM =3; 
      
      const LogLevel EXCEPTION_ERROR =4; 
      
      const LogLevel FLOW_CONTROL_ERROR =5; 
      
      const LogLevel RANGE_ERROR =6; 
      
      const LogLevel USAGE_ERROR = 7; 
      
      const LogLevel ADMINISTRATIVE_EVENT = 8; 
      
      const LogLevel STATISTIC_REPORT = 9; 


      enum OperationalState {disabled, enabled};

      enum AdministrativeState {locked, unlocked};

      enum LogFullAction {WRAP, HALT};
     
      typedef unsigned long long RecordId;

      struct LogTime { 
         long seconds;     
         long nanoseconds; 
      };

      struct AvailabilityStatus { 
         boolean off_duty;  
         boolean log_full;  
      };
        
      struct ProducerLogRecord { 
         string producerId;      
         string producerName;    
         LogLevel level;         
         string logData;         
         
      };
     
      struct LogRecord { 
         RecordId id;      
         LogTime time;     
         ProducerLogRecord info; 
      }; 
     
      typedef sequence<LogRecord> LogRecordSequence;
      typedef sequence<ProducerLogRecord> ProducerLogRecordSequence;
      typedef sequence<LogLevel> LogLevelSequence;
      typedef sequence<string> StringSeq;
     
      exception InvalidParam {
         string details;   
      };
      
      interface LogStatus {
         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();
      };

      interface LogConsumer : LogStatus {

         RecordId get_record_id_from_time (in LogTime fromTime)
            raises(InvalidParam);
         LogRecordSequence retrieve_records( 
               inout RecordId currentId, 
               inout unsigned long howMany
               )
            raises(InvalidParam);
         
         LogRecordSequence retrieve_records_by_level( 
               inout RecordId currentId, 
               inout unsigned long howMany, 
               in LogLevelSequence valueList
               )
            raises(InvalidParam);
            
         LogRecordSequence retrieve_records_by_producer_id( 
               inout RecordId currentId, 
               inout unsigned long howMany, 
               in StringSeq valueList
               )
            raises(InvalidParam);

         LogRecordSequence retrieve_records_by_producer_name( 
               inout RecordId currentId, 
               inout unsigned long howMany, 
               in StringSeq valueList
               )
            raises(InvalidParam);
      };

      interface LogProducer : LogStatus { 
         
         oneway void write_records( 
            in ProducerLogRecordSequence records
            );
         oneway void write_record( 
            in ProducerLogRecord record
            );
      };
     
      interface LogAdministrator : LogStatus {
         
         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 ();
      };
   };
#endif // MODULE_COS_LW_LOG_IDL

---