XrdClCopyProcess.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD 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 Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------

#ifndef __XRD_CL_COPY_PROCESS_HH__
#define __XRD_CL_COPY_PROCESS_HH__

#include "XrdCl/XrdClURL.hh"
#include "XrdCl/XrdClXRootDResponses.hh"
#include <stdint.h>

namespace XrdCl
{
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class CopyProgressHandler
  {
    public:
      virtual ~CopyProgressHandler() {}

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void BeginJob( uint16_t   jobNum,
                             uint16_t   jobTotal,
                             const URL *source,
                             const URL *destination ) = 0;

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void EndJob( const XRootDStatus &status ) = 0;

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void JobProgress( uint64_t bytesProcessed,
                                uint64_t bytesTotal ) = 0;
  };

  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  struct JobDescriptor
  {
    JobDescriptor(): sourceLimit(1), force(false), posc(false), coerce(false),
      thirdParty(false), checkSumPrint(false)
    {}

    URL              source;               
    URL              target;               
    uint16_t         sourceLimit;          

    bool             force;                
    bool             posc;                 

    bool             coerce;               

    bool             thirdParty;           

    bool             thirdPartyFallBack;   


    bool             checkSumPrint;        

    std::string      checkSumType;         
    std::string      checkSumPreset;       

    std::string      sourceCheckSum;       

    std::string      targetCheckSum;       

    XRootDStatus     status;               

    std::vector<URL> sources;              

    URL              realTarget;           
  };

  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class CopyJob
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      CopyJob( JobDescriptor *jobDesc ):
        pJob( jobDesc ) {}

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~CopyJob()
      {
      }

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual XRootDStatus Run( CopyProgressHandler *progress = 0 ) = 0;

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      JobDescriptor *GetDescriptor() const
      {
        return pJob;
      }

    protected:
      JobDescriptor *pJob;
  };

  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class CopyProcess
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      CopyProcess() {}

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~CopyProcess();

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void AddJob( JobDescriptor *job )
      {
        pJobDescs.push_back( job );
      }

      //------------------------------------------------------------------------
      // Prepare the copy jobs
      //------------------------------------------------------------------------
      XRootDStatus Prepare();

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Run( CopyProgressHandler *handler );

    private:
      void CleanUpJobs();
      std::list<JobDescriptor*>  pJobDescs;
      std::list<CopyJob*>        pJobs;
  };
}

#endif // __XRD_CL_COPY_PROCESS_HH__