ProgressDisplay Class Reference

Inheritance diagram for ProgressDisplay:

Collaboration diagram for ProgressDisplay:

Public Member Functions
	ProgressDisplay ()
	Constructor.
	ProgressDisplay ()
virtual void	BeginJob (uint32_t jobNum, uint32_t jobTotal, const XrdCl::URL *source, const XrdCl::URL *destination)
	Begin job.
virtual void	EndJob (uint32_t jobNum, const XrdCl::PropertyList *results)
	End job.
virtual void	EndJob (uint32_t jobNum, const XrdCl::PropertyList *results)
std::string	GetProgressBar (time_t now)
	Get progress bar.
std::string	GetSummaryBar (time_t now)
	Get sumary bar.
virtual void	JobProgress (uint32_t jobNum, uint64_t bytesProcessed, uint64_t bytesTotal)
	Job progress.
virtual void	JobProgress (uint32_t jobNum, uint64_t bytesProcessed, uint64_t bytesTotal)
void	PrintAdditionalCheckSum (bool print)
void	PrintCheckSum (const XrdCl::URL *url, const std::string &checkSum, uint64_t size)
	Print the checksum.
void	PrintProgressBar (bool print)
void	PrintSourceCheckSum (bool print)
void	PrintTargetCheckSum (bool print)
Public Member Functions inherited from XrdCl::CopyProgressHandler
virtual	~CopyProgressHandler ()
virtual bool	ShouldCancel (uint32_t jobNum)
	Determine whether the job should be canceled.

Detailed Description

Definition at line 47 of file XrdClCopy.cc.

Constructor & Destructor Documentation

ProgressDisplay() [1/2]

ProgressDisplay::ProgressDisplay ( )

inline

Constructor.

Definition at line 53 of file XrdClCopy.cc.

                     : pPrevious(0), pPrintProgressBar(true),
      pPrintSourceCheckSum(false), pPrintTargetCheckSum(false),
      pPrintAdditionalCheckSum(false)
    {}

ProgressDisplay() [2/2]

ProgressDisplay::ProgressDisplay ( )

inline

Definition at line 1459 of file XrdClFS.cc.

                     : pBytesProcessed(0), pBytesTotal(0), pPrevious(0)
    {}

Member Function Documentation

BeginJob()

virtual void ProgressDisplay::BeginJob ( uint32_t jobNum, uint32_t jobTotal, const XrdCl::URL * source, const XrdCl::URL * destination )

inlinevirtual

Begin job.

Reimplemented from XrdCl::CopyProgressHandler.

Definition at line 61 of file XrdClCopy.cc.

    {
      XrdSysMutexHelper scopedLock( pMutex );
      if( pPrintProgressBar )
      {
        if( jobTotal > 1 )
        {
          std::cerr << "Job: "    << jobNum << "/" << jobTotal << std::endl;
          std::cerr << "Source: " << source->GetURL() << std::endl;
          std::cerr << "Target: " << destination->GetURL() << std::endl;
        }
      }
      pPrevious = 0;
 
      JobData d;
      d.started = time(0);
      d.source  = source;
      d.target  = destination;
      pOngoingJobs[jobNum] = d;
    }

References XrdCl::URL::GetURL().

Here is the call graph for this function:

EndJob() [1/2]

virtual void ProgressDisplay::EndJob ( uint32_t jobNum, const XrdCl::PropertyList * results )

inlinevirtual

End job.

Reimplemented from XrdCl::CopyProgressHandler.

Definition at line 88 of file XrdClCopy.cc.

    {
      XrdSysMutexHelper scopedLock( pMutex );
 
      std::map<uint32_t, JobData>::iterator it = pOngoingJobs.find( jobNum );
      if( it == pOngoingJobs.end() )
        return;
 
      JobData &d = it->second;
 
      // make sure the last available status was printed, which may not be
      // the case when processing stdio since we throttle printing and don't
      // know the total size
      JobProgress( jobNum, d.bytesProcessed, d.bytesTotal );
 
      if( pPrintProgressBar )
      {
        if( pOngoingJobs.size() > 1 )
          std::cerr << "\r" << std::string(70, ' ') << "\r";
        else
          std::cerr << std::endl;
      }
 
      XrdCl::XRootDStatus st;
      results->Get( "status", st );
      if( !st.IsOK() )
      {
        pOngoingJobs.erase(it);
        return;
      }
 
      std::string checkSum;
      uint64_t    size;
      results->Get( "size", size );
      if( pPrintSourceCheckSum )
      {
        results->Get( "sourceCheckSum", checkSum );
        PrintCheckSum( d.source, checkSum, size );
      }
 
      if( pPrintTargetCheckSum )
      {
        results->Get( "targetCheckSum", checkSum );
        PrintCheckSum( d.target, checkSum, size );
      }
 
      if( pPrintAdditionalCheckSum )
      {
        std::vector<std::string> addcksums;
        results->Get( "additionalCkeckSum", addcksums );
        for( auto &cks : addcksums )
          PrintCheckSum( d.source, cks, size );
      }
 
      pOngoingJobs.erase(it);
    }

References XrdCl::PropertyList::Get(), XrdCl::Status::IsOK(), JobProgress(), and PrintCheckSum().

Here is the call graph for this function:

EndJob() [2/2]

virtual void ProgressDisplay::EndJob ( uint32_t jobNum, const XrdCl::PropertyList * result )

inlinevirtual

Notify when the previous job has finished

Parameters

jobNum	job number
result	result of the job

Reimplemented from XrdCl::CopyProgressHandler.

Definition at line 1465 of file XrdClFS.cc.

    {
      JobProgress( jobNum, pBytesProcessed, pBytesTotal );
      std::cerr << std::endl;
    }

References JobProgress().

Here is the call graph for this function:

GetProgressBar()

std::string ProgressDisplay::GetProgressBar ( time_t now )

inline

Get progress bar.

Definition at line 148 of file XrdClCopy.cc.

    {
      JobData &d = pOngoingJobs.begin()->second;
 
      uint64_t speed = 0;
      if( now-d.started )
        speed = d.bytesProcessed/(now-d.started);
      else
        speed = d.bytesProcessed;
 
      std::string bar;
      int prog = 0;
      int proc = 0;
 
      if( d.bytesTotal )
      {
        prog = (int)((double)d.bytesProcessed/d.bytesTotal*50);
        proc = (int)((double)d.bytesProcessed/d.bytesTotal*100);
      }
      else
      {
        prog = 50;
        proc = 100;
      }
      bar.append( prog, '=' );
      if( prog < 50 )
        bar += ">";
 
      std::ostringstream o;
      o << "[" << XrdCl::Utils::BytesToString(d.bytesProcessed) << "B/";
      o << XrdCl::Utils::BytesToString(d.bytesTotal) << "B]";
      o << "[" << std::setw(3) << std::right << proc << "%]";
      o << "[" << std::setw(50) << std::left;
      o << bar;
      o << "]";
      o << "[" << XrdCl::Utils::BytesToString(speed) << "B/s]  ";
      return o.str();
    }

References XrdCl::Utils::BytesToString().

Referenced by JobProgress().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSummaryBar()

std::string ProgressDisplay::GetSummaryBar ( time_t now )

inline

Get sumary bar.

Definition at line 190 of file XrdClCopy.cc.

    {
      std::map<uint32_t, JobData>::iterator it;
      std::ostringstream o;
 
      for( it = pOngoingJobs.begin(); it != pOngoingJobs.end(); ++it )
      {
        JobData  &d      = it->second;
        uint32_t  jobNum = it->first;
 
        uint64_t speed = 0;
        if( now-d.started )
          speed = d.bytesProcessed/(now-d.started);
 
        int proc = 0;
        if( d.bytesTotal )
          proc = (int)((double)d.bytesProcessed/d.bytesTotal*100);
        else
          proc = 100;
 
        o << "[#" << jobNum << ": ";
        o << proc << "% ";
        o << XrdCl::Utils::BytesToString(speed) << "B/s] ";
      }
      o << "        ";
      return o.str();
    }

References XrdCl::Utils::BytesToString().

Referenced by JobProgress().

Here is the call graph for this function:

Here is the caller graph for this function:

JobProgress() [1/2]

virtual void ProgressDisplay::JobProgress ( uint32_t jobNum, uint64_t bytesProcessed, uint64_t bytesTotal )

inlinevirtual

Job progress.

Reimplemented from XrdCl::CopyProgressHandler.

Definition at line 221 of file XrdClCopy.cc.

    {
      XrdSysMutexHelper scopedLock( pMutex );
 
      if( pPrintProgressBar )
      {
        time_t now = time(0);
        if( (now - pPrevious < 1) && (bytesProcessed != bytesTotal) )
          return;
        pPrevious = now;
 
        std::map<uint32_t, JobData>::iterator it = pOngoingJobs.find( jobNum );
        if( it == pOngoingJobs.end() )
          return;
 
        JobData &d = it->second;
 
        d.bytesProcessed = bytesProcessed;
        d.bytesTotal     = bytesTotal;
 
        std::string progress;
        if( pOngoingJobs.size() == 1 )
          progress = GetProgressBar( now );
        else
          progress = GetSummaryBar( now );
 
        std::cerr << "\r" << progress << std::flush;
      }
    }

References GetProgressBar(), and GetSummaryBar().

Referenced by EndJob().

Here is the call graph for this function:

Here is the caller graph for this function:

JobProgress() [2/2]

virtual void ProgressDisplay::JobProgress ( uint32_t jobNum, uint64_t bytesProcessed, uint64_t bytesTotal )

inlinevirtual

Notify about the progress of the current job

Parameters

jobNum	job number
bytesProcessed	bytes processed by the current job
bytesTotal	total number of bytes to be processed by the current job

Reimplemented from XrdCl::CopyProgressHandler.

Definition at line 1474 of file XrdClFS.cc.

    {
      pBytesProcessed = bytesProcessed;
      pBytesTotal     = bytesTotal;
 
      time_t now = time(0);
      if( (now - pPrevious < 1) && (bytesProcessed != bytesTotal) )
        return;
      pPrevious = now;
 
      std::cerr << "\r";
      std::cerr << "Progress: ";
      std::cerr << XrdCl::Utils::BytesToString(bytesProcessed) << "B ";
 
      if( bytesTotal )
        std::cerr << "(" << bytesProcessed*100/bytesTotal << "%)";
 
      std::cerr << std::flush;
     }

References XrdCl::Utils::BytesToString().

Here is the call graph for this function:

PrintAdditionalCheckSum()

void ProgressDisplay::PrintAdditionalCheckSum ( bool print )

inline

Definition at line 284 of file XrdClCopy.cc.

{ pPrintAdditionalCheckSum = print; }

Referenced by main().

Here is the caller graph for this function:

PrintCheckSum()

void ProgressDisplay::PrintCheckSum ( const XrdCl::URL * url, const std::string & checkSum, uint64_t size )

inline

Print the checksum.

Definition at line 256 of file XrdClCopy.cc.

    {
      if( checkSum.empty() )
        return;
      std::string::size_type i = checkSum.find( ':' );
      std::cerr << checkSum.substr( 0, i+1 ) << " ";
      std::cerr << checkSum.substr( i+1, checkSum.length()-i ) << " ";
 
      if( url->IsLocalFile() )
        std::cerr << url->GetPath() << " ";
      else
      {
        std::cerr << url->GetProtocol() << "://" << url->GetHostId();
        std::cerr << url->GetPath() << " ";
      }
 
      std::cerr << size;
      std::cerr << std::endl;
    }

References XrdCl::URL::GetHostId(), XrdCl::URL::GetPath(), XrdCl::URL::GetProtocol(), and XrdCl::URL::IsLocalFile().

Referenced by EndJob().

Here is the call graph for this function:

Here is the caller graph for this function:

PrintProgressBar()

void ProgressDisplay::PrintProgressBar ( bool print )

inline

Definition at line 281 of file XrdClCopy.cc.

{ pPrintProgressBar    = print; }

Referenced by main().

Here is the caller graph for this function:

PrintSourceCheckSum()

void ProgressDisplay::PrintSourceCheckSum ( bool print )

inline

Definition at line 282 of file XrdClCopy.cc.

{ pPrintSourceCheckSum = print; }

Referenced by main().

Here is the caller graph for this function:

PrintTargetCheckSum()

void ProgressDisplay::PrintTargetCheckSum ( bool print )

inline

Definition at line 283 of file XrdClCopy.cc.

{ pPrintTargetCheckSum = print; }

Referenced by main().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• XrdClCopy.cc
• XrdClFS.cc