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

LogState.h

Go to the documentation of this file.

/***
 *    Copyright (C) 2004-2005 BoilerPlate.org
 *    All rights reserved
 *
 *    This file is part of BoilerPlate.
 *
 *    BoilerPlate is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation version 2
 *
 *    BoilerPlate is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with BoilerPlate; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **/

#ifndef LOGSTATE_H
#define LOGSTATE_H

#include <string>
#include <iostream>
#include <fstream>
#include <map>
#include <pthread.h>
#include <sys/time.h>

#include "BP_CosLw_Log.h"
#include "CorbaServer.h"
#include "IdxRecordId.h"
#include "LevelMap.h"

class LogState
{
   public:
      LogState(std::string log_name, unsigned long maxsize)
         throw(OrbInit::InitializationError);

      LogState(std::string log_name, 
            std::string log_dir,
            unsigned long maxsize
            )
         throw(OrbInit::InitializationError);

      ~LogState();
      
      CosLwLog::LogFullAction getFullAction() 
         { return(_running_state.full_action); }

      CosLwLog::AvailabilityStatus getAvailStatus() 
         { return(_running_state.avail_status); }

      CosLwLog::OperationalState getOpState() 
         { return(_running_state.op_state); }

      CosLwLog::AdministrativeState getAdminState() 
         { return(_running_state.admin_state);}

      void write_record(CosLwLog::LogRecord& recd);

      unsigned long get_max_size() 
         { return(_running_state.max_size); }

      void set_max_size(const unsigned long& max_size);

      void setLogFullAction(const CosLwLog::LogFullAction& new_full_action);

      void setAdminState(const CosLwLog::AdministrativeState& new_state);


      void clearLog();

      void destroyLog();


      unsigned long get_current_size(); 
      unsigned long get_current_numb_records() 
         { return(_current_record.stop_rcd_id); }

      const IdxRecordId::IdxRecord find_log(const CosLwLog::LogTime& log_time);

      const IdxRecordId::IdxRecord find_log(const CosLwLog::RecordId& recid);

      const std::string get_log_file_name(
            const unsigned long& start_secs,
            const unsigned long& start_nanos
            );

      const bool future_id(const CosLwLog::RecordId& recid) const;

      CosLwLog::RecordId future_id();

      CosLwLog::LogTime init_logtime();

      bool is_enabled() { return(_running_state.op_state == CosLwLog::enabled);}
         

   private:
      const std::string _log_file_name;

      const std::string _log_dir;
     
      std::fstream _log;


      struct LogRunningState
      {
         CosLwLog::LogFullAction       full_action;
         CosLwLog::AvailabilityStatus  avail_status;
         CosLwLog::OperationalState    op_state;
         CosLwLog::AdministrativeState admin_state;
         unsigned long                 max_size;
      };

      LogRunningState _running_state;

      void _open_running_state(const unsigned long& max_size);
      void _save_running_state();

      unsigned long _current_records;

      IdxRecordId::IdxRecord _current_record;

      IdxRecordId _recdid_idx;


      pthread_mutex_t _state_mutex;

      pthread_cond_t  _full_state;

      bool _open_file(std::ios_base::openmode mode);

      bool _init(const unsigned long& max_size);
      void _revise_state();

      bool _check_state_for_write();

      std::string _make_log_name(std::string& log_name, std::string& log_dir);

      std::string _make_log_name(std::string& log_name);

      void _log_msg(
            const std::string& producername,
            const std::string& msg,
            const CosLwLog::LogLevel& leve
            );
};

#endif

---