DTRStatus.h

// -*- indent-tabs-mode: nil -*-

#ifndef __ARC_DTRSTATUS_H__
#define __ARC_DTRSTATUS_H__

#include <string>
#include <vector>

namespace DataStaging {
      

  class DTRStatus {

  public:
    
    enum DTRStatusType {
        
      // ORDER IS IMPORTANT!!

      NEW,

      CHECK_CACHE,
      
      CHECKING_CACHE,

      CACHE_WAIT,
      
      CACHE_CHECKED,

      RESOLVE,

      RESOLVING,

      RESOLVED,

      QUERY_REPLICA,

      QUERYING_REPLICA,

      REPLICA_QUERIED,

      PRE_CLEAN,

      PRE_CLEANING,

      PRE_CLEANED,

      STAGE_PREPARE,

      STAGING_PREPARING,

      STAGING_PREPARING_WAIT,

      STAGED_PREPARED,

      TRANSFER,

      TRANSFERRING,
      
      TRANSFERRING_CANCEL,

      TRANSFERRED,
      
      RELEASE_REQUEST,

      RELEASING_REQUEST,

      REQUEST_RELEASED,
    
      REGISTER_REPLICA,

      REGISTERING_REPLICA,
      
      REPLICA_REGISTERED,
 
      PROCESS_CACHE,

      PROCESSING_CACHE,
      
      CACHE_PROCESSED,

      DONE,

      CANCELLED,

      CANCELLED_FINISHED,

      ERROR,

      NULL_STATE
      
    };
    
    DTRStatus(const DTRStatusType& status, std::string desc="")
      : status(status), desc(desc) {}
    DTRStatus() 
      : status(NEW), desc ("") {}

    bool operator==(const DTRStatusType& s) const {
      return status == s;
    }
    bool operator==(const DTRStatus& s) const {
      return status == s.status;
    }
  

    bool operator!=(const DTRStatusType& s) const {
      return status != s;
    }
    bool operator!=(const DTRStatus& s) const {
      return status != s.status;
    }
  
    DTRStatus& operator=(const DTRStatusType& s) {
      status = s;
      return *this;
    }

    std::string str() const;

    void SetDesc(const std::string& d) {
      desc = d;
    }
    
    std::string GetDesc() const {
      return desc;
    }
    
    DTRStatusType GetStatus() const {
      return status;
    }

    // The actions in the following two vectors must match
    static const std::vector<DTRStatus::DTRStatusType> ToProcessStates;
    static const std::vector<DTRStatus::DTRStatusType> ProcessingStates;

    static const std::vector<DTRStatus::DTRStatusType> StagedStates;

  private:
  
    DTRStatusType status;
    std::string desc;

  }; // DTRStatus


  class DTRErrorStatus {

   public:

    enum DTRErrorStatusType {

      NONE_ERROR,

      INTERNAL_LOGIC_ERROR,

      INTERNAL_PROCESS_ERROR,

      SELF_REPLICATION_ERROR,

      CACHE_ERROR,

      TEMPORARY_REMOTE_ERROR,

      PERMANENT_REMOTE_ERROR,

      LOCAL_FILE_ERROR,

      TRANSFER_SPEED_ERROR,
      
      STAGING_TIMEOUT_ERROR
    };

    enum DTRErrorLocation {

      NO_ERROR_LOCATION,

      ERROR_SOURCE,

      ERROR_DESTINATION,

      ERROR_TRANSFER,

      ERROR_UNKNOWN
    };


    DTRErrorStatus(DTRErrorStatusType status,
                   DTRStatus::DTRStatusType error_state,
                   DTRErrorLocation location,
                   const std::string& desc = ""):
      error_status(status),
      last_error_state(error_state),
      error_location(location),
      desc(desc) {};

    DTRErrorStatus() :
      error_status(NONE_ERROR),
      last_error_state(DTRStatus::NULL_STATE),
      error_location(NO_ERROR_LOCATION),
      desc("") {};

    DTRErrorStatusType GetErrorStatus() const {
     return error_status;
    }

    DTRStatus::DTRStatusType GetLastErrorState() const {
      return last_error_state.GetStatus();
    }

    DTRErrorLocation GetErrorLocation() const {
      return error_location;
    }

    std::string GetDesc() const {
      return desc;
    }

    bool operator==(const DTRErrorStatusType& s) const {
      return error_status == s;
    }
    bool operator==(const DTRErrorStatus& s) const {
      return error_status == s.error_status;
    }

    bool operator!=(const DTRErrorStatusType& s) const {
      return error_status != s;
    }
    bool operator!=(const DTRErrorStatus& s) const {
      return error_status != s.error_status;
    }

    DTRErrorStatus& operator=(const DTRErrorStatusType& s) {
      error_status = s;
      return *this;
    }

   private:
    DTRErrorStatusType error_status;
    DTRStatus last_error_state;
    DTRErrorLocation error_location;
    std::string desc;

  };

} // namespace DataStaging

#endif /*__ARC_DTRSTATUS_H_*/