SonicClientBase Class Reference

#include <SonicClientBase.h>

Inheritance diagram for SonicClientBase:

Public Member Functions
const std::string &	debugName () const
virtual void	dispatch (edm::WaitingTaskWithArenaHolder holder)=0
void	setDebugName (const std::string &debugName)
	SonicClientBase ()
virtual	~SonicClientBase ()=default

Protected Member Functions
virtual unsigned	allowedTries () const
virtual void	evaluate ()=0
void	finish (bool success, std::exception_ptr eptr=std::exception_ptr{})
void	setStartTime ()

Protected Attributes
std::string	debugName_
edm::WaitingTaskWithArenaHolder	holder_
std::chrono::time_point< std::chrono::high_resolution_clock >	t0_
unsigned	tries_

Detailed Description

Definition at line 11 of file SonicClientBase.h.

Constructor & Destructor Documentation

SonicClientBase()

SonicClientBase::SonicClientBase ( )

inline

Definition at line 14 of file SonicClientBase.h.

: tries_(0) {}

~SonicClientBase()

virtual SonicClientBase::~SonicClientBase ( )

virtualdefault

Member Function Documentation

allowedTries()

virtual unsigned SonicClientBase::allowedTries ( ) const

inlineprotectedvirtual

Definition at line 29 of file SonicClientBase.h.

{ return 0; }

debugName()

const std::string& SonicClientBase::debugName ( ) const

inline

Definition at line 20 of file SonicClientBase.h.

{ return debugName_; }

References debugName_.

Referenced by setDebugName().

dispatch()

virtual void SonicClientBase::dispatch ( edm::WaitingTaskWithArenaHolder  holder )

pure virtual

Implemented in SonicClientPseudoAsync< InputT, OutputT >, SonicClientSync< InputT, OutputT >, and SonicClientAsync< InputT, OutputT >.

evaluate()

virtual void SonicClientBase::evaluate ( )

protectedpure virtual

Referenced by SonicClientAsync< InputT, OutputT >::dispatch(), SonicClientSync< InputT, OutputT >::dispatch(), and SonicClientPseudoAsync< InputT, OutputT >::waitForNext().

finish()

void SonicClientBase::finish ( bool  success, std::exception_ptr  eptr = std::exception_ptr{}  )

inlineprotected

Definition at line 38 of file SonicClientBase.h.

                                                                    {}) {
    //retries are only allowed if no exception was raised
    if (!success and !eptr) {
      ++tries_;
      //if max retries has not been exceeded, call evaluate again
      if (tries_ < allowedTries()) {
        evaluate();
        //avoid calling doneWaiting() twice
        return;
      }
      //prepare an exception if exceeded
      else {
        cms::Exception ex("SonicCallFailed");
        ex << "call failed after max " << tries_ << " tries";
        eptr = make_exception_ptr(ex);
      }
    }
    if (!debugName_.empty()) {
      auto t1 = std::chrono::high_resolution_clock::now();
      edm::LogInfo(debugName_) << "Client time: "
                               << std::chrono::duration_cast<std::chrono::microseconds>(t1 - t0_).count();
    }
    holder_.doneWaiting(eptr);
  }

Referenced by progressbar.ProgressBar::__next__().

setDebugName()

void SonicClientBase::setDebugName ( const std::string &  debugName )

inline

Definition at line 19 of file SonicClientBase.h.

{ debugName_ = debugName; }

References debugName(), and debugName_.

setStartTime()

void SonicClientBase::setStartTime ( )

inlineprotected

Definition at line 31 of file SonicClientBase.h.

                      {
    tries_ = 0;
    if (debugName_.empty())
      return;
    t0_ = std::chrono::high_resolution_clock::now();
  }

References debugName_, fileCollector::now, t0_, and tries_.

Referenced by SonicClientAsync< InputT, OutputT >::dispatch(), SonicClientSync< InputT, OutputT >::dispatch(), and SonicClientPseudoAsync< InputT, OutputT >::dispatch().

Member Data Documentation

debugName_

std::string SonicClientBase::debugName_

protected

Definition at line 68 of file SonicClientBase.h.

Referenced by debugName(), setDebugName(), and setStartTime().

holder_

edm::WaitingTaskWithArenaHolder SonicClientBase::holder_

protected

Definition at line 65 of file SonicClientBase.h.

Referenced by SonicClientAsync< InputT, OutputT >::dispatch(), SonicClientSync< InputT, OutputT >::dispatch(), and SonicClientPseudoAsync< InputT, OutputT >::dispatch().

t0_

std::chrono::time_point<std::chrono::high_resolution_clock> SonicClientBase::t0_

protected

Definition at line 69 of file SonicClientBase.h.

Referenced by setStartTime().

tries_

unsigned SonicClientBase::tries_

protected

Definition at line 64 of file SonicClientBase.h.

Referenced by setStartTime().