XrdClCopyProcess.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2014 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// This file is part of the XRootD software suite.
//
// 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/>.
//
// In applying this licence, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
//------------------------------------------------------------------------------

#ifndef __XRD_CL_COPY_PROCESS_HH__
#define __XRD_CL_COPY_PROCESS_HH__

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

namespace XrdCl
{
  class CopyJob;

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

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

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void EndJob( uint16_t            jobNum,
                           const PropertyList *result )
      {
        (void)jobNum; (void)result;
      };

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void JobProgress( uint16_t jobNum,
                                uint64_t bytesProcessed,
                                uint64_t bytesTotal )
      {
        (void)jobNum; (void)bytesProcessed; (void)bytesTotal;
      };

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool ShouldCancel( uint16_t jobNum )
      {
        (void)jobNum;
        return false;
      }
  };

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

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

      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus AddJob( const PropertyList &properties,
                           PropertyList       *results );

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

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

    private:
      void CleanUpJobs();
      std::vector<PropertyList>   pJobProperties;
      std::vector<PropertyList*>  pJobResults;
      std::vector<CopyJob*>       pJobs;
  };
}

#endif // __XRD_CL_COPY_PROCESS_HH__