RecallReportPacker.hpp

/******************************************************************************
 *
 * This file is part of the Castor project.
 * See http://castor.web.cern.ch/castor
 *
 * Copyright (C) 2003  CERN
 * This program 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; either version 2
 * of the License, or (at your option) any later version.
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * 
 *
 * @author Castor Dev team, castor-dev@cern.ch
 *****************************************************************************/

#pragma once

#include "castor/tape/tapeserver/daemon/ReportPackerInterface.hpp"
#include "castor/log/LogContext.hpp"
#include "castor/tape/tapeserver/client/ClientInterface.hpp"
#include "castor/server/Threading.hpp"
#include "castor/server/BlockingQueue.hpp"

namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  
class RecallReportPacker : public ReportPackerInterface<detail::Recall> {
public:
  /**
   * Constructor
   * @param tg the client to whom we report the success/failures 
   * @param reportFilePeriod how often  do we report to the client
   * @param lc log context, copied du to threads
   */
  RecallReportPacker(client::ClientInterface & tg,unsigned int reportFilePeriod,
          log::LogContext lc);
  
  virtual ~RecallReportPacker();
  
 /**
   * Create into the MigrationReportPacker a report for the successful migration
   * of migratedFile
   * @param migratedFile the file successfully migrated
   * @param checksum the checksum the DWT has computed for the file 
   */
  virtual void reportCompletedJob(const FileStruct& recalledFile,
  u_int32_t checksum, u_int64_t size);
  
  /**
   * Create into the MigrationReportPacker a report for the failed migration
   * of migratedFile
   * @param migratedFile the file which failed 
   * @param msg the message error with the failure 
   * @param error_code the error code with the failure 
   */
  virtual void reportFailedJob(const FileStruct & recalledFile,const std::string& msg,int error_code);
       
  /**
   * Create into the MigrationReportPacker a report for the nominal end of session
   */
  virtual void reportEndOfSession();
  
  /**
   * Create into the MigrationReportPacker a report for an erroneous end of session
   * @param msg The error message 
   * @param error_code The error code given by the drive
   */
  virtual void reportEndOfSessionWithErrors(const std::string msg,int error_code); 
  
  void reportStuckOn(FileStruct& file);

  /**
   * Start the inner thread
   */
  void startThreads() { m_workerThread.start(); }
  
  /**
   * Stop the inner thread
   */
  void waitThread() { m_workerThread.wait(); }
  
private:
  //inner classes use to store content while receiving a report 
  class Report {
    const bool m_endNear;
  public:
    Report(bool b):m_endNear(b){}
    virtual ~Report(){}
    virtual void execute(RecallReportPacker& packer)=0;
    bool goingToEnd() const {return m_endNear;};
  };
  class ReportSuccessful :  public Report {
    const FileStruct m_recalledFile;
    u_int32_t m_checksum;
    u_int64_t m_size;
  public:
    ReportSuccessful(const FileStruct& file,u_int32_t checksum,
      u_int64_t size): 
    Report(false),m_recalledFile(file),m_checksum(checksum),m_size(size){}
    virtual void execute(RecallReportPacker& _this);
  };
  class ReportError : public Report {
    const FileStruct m_recalledFile;
    const std::string m_error_msg;
    const int m_error_code;
  public:
    ReportError(const FileStruct& file,std::string msg,int error_code):
    Report(false),m_recalledFile(file),m_error_msg(msg),m_error_code(error_code){}

    virtual void execute(RecallReportPacker& _this);
  };
  class ReportStuck : public Report {
    const FileStruct m_recalledFile;
  public:
    ReportStuck(const FileStruct& file):
    Report(false),m_recalledFile(file){}

    virtual void execute(RecallReportPacker& _this);
  };
  
  class ReportEndofSession : public Report {
  public:
    ReportEndofSession():Report(true){}
    virtual void execute(RecallReportPacker& _this);
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
    int m_error_code;
  public:
    ReportEndofSessionWithErrors(std::string msg,int error_code):
    Report(true),m_message(msg),m_error_code(error_code){}
  
    virtual void execute(RecallReportPacker& _this);
  };
  
  class WorkerThread: public castor::server::Thread {
    RecallReportPacker & m_parent;
  public:
    WorkerThread(RecallReportPacker& parent);
    virtual void run();
  } m_workerThread;
  
  /**
   * Function periodically called to report the results to the client
   */
  void flush();
  
  castor::server::Mutex m_producterProtection;
  
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
  castor::server::BlockingQueue<Report*> m_fifo;
  
  /**
   How often do we report to the client
   */
  unsigned int m_reportFilePeriod;
  
  /**
   * Is set as true as soon as we process a reportFailedJob
   * That we can do a sanity check to make sure we always call 
   * the right end of the session  
   */
  bool m_errorHappened;
};

}}}}