SonicClientBase Class Reference

#include <SonicClientBase.h>

Inheritance diagram for SonicClientBase:

Public Member Functions
const std::string &	clientName () const
const std::string &	debugName () const
virtual void	dispatch (edm::WaitingTaskWithArenaHolder holder)
virtual void	dispatch ()
SonicMode	mode () const
virtual void	reset ()
	SonicClientBase (const edm::ParameterSet &params, const std::string &debugName, const std::string &clientName)
virtual	~SonicClientBase ()=default

Static Public Member Functions
static void	fillBasePSetDescription (edm::ParameterSetDescription &desc, bool allowRetry=true)

Protected Member Functions
virtual void	evaluate ()=0
void	finish (bool success, std::exception_ptr eptr=std::exception_ptr{})
void	setMode (SonicMode mode)
void	start (edm::WaitingTaskWithArenaHolder holder)
void	start ()

Protected Attributes
unsigned	allowedTries_
std::string	clientName_
std::string	debugName_
std::unique_ptr< SonicDispatcher >	dispatcher_
std::string	fullDebugName_
std::optional< edm::WaitingTaskWithArenaHolder >	holder_
SonicMode	mode_
unsigned	tries_
bool	verbose_

Friends
class	SonicDispatcher
class	SonicDispatcherPseudoAsync

Detailed Description

Definition at line 18 of file SonicClientBase.h.

Constructor & Destructor Documentation

SonicClientBase()

SonicClientBase::SonicClientBase	(	const edm::ParameterSet &	params,
		const std::string &	debugName,
		const std::string &	clientName
	)

Definition at line 5 of file SonicClientBase.cc.

References Async, clientName_, Exception, fullDebugName_, submitPVValidationJobs::params, PseudoAsync, setMode(), AlCaHLTBitMon_QueryRunRegistry::string, and Sync.

    : allowedTries_(params.getUntrackedParameter<unsigned>("allowedTries", 0)),
      debugName_(debugName),
      clientName_(clientName),
      fullDebugName_(debugName_) {
  if (!clientName_.empty())
    fullDebugName_ += ":" + clientName_;

  std::string modeName(params.getParameter<std::string>("mode"));
  if (modeName == "Sync")
    setMode(SonicMode::Sync);
  else if (modeName == "Async")
    setMode(SonicMode::Async);
  else if (modeName == "PseudoAsync")
    setMode(SonicMode::PseudoAsync);
  else
    throw cms::Exception("Configuration") << "Unknown mode for SonicClient: " << modeName;
}

~SonicClientBase()

virtual SonicClientBase::~SonicClientBase ( )

virtualdefault

Member Function Documentation

clientName()

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

inline

Definition at line 27 of file SonicClientBase.h.

References clientName_.

{ return clientName_; }

debugName()

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

inline

Definition at line 26 of file SonicClientBase.h.

References debugName_.

{ return debugName_; }

dispatch() [1/2]

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

inlinevirtual

Definition at line 31 of file SonicClientBase.h.

References dispatcher_, and eostools::move().

{ dispatcher_->dispatch(std::move(holder)); }

dispatch() [2/2]

virtual void SonicClientBase::dispatch ( )

inlinevirtual

Definition at line 34 of file SonicClientBase.h.

References dispatcher_.

{ dispatcher_->dispatch(); }

evaluate()

virtual void SonicClientBase::evaluate ( )

protectedpure virtual

Implemented in TritonClient.

Referenced by SonicDispatcher::dispatch(), finish(), and SonicDispatcherPseudoAsync::waitForNext().

fillBasePSetDescription()

void SonicClientBase::fillBasePSetDescription ( edm::ParameterSetDescription &  desc, bool  allowRetry = true  )

static

Definition at line 73 of file SonicClientBase.cc.

References submitPVResolutionJobs::desc.

Referenced by TritonClient::fillPSetDescription().

                                                                                               {
  //restrict allowed values
  desc.ifValue(edm::ParameterDescription<std::string>("mode", "PseudoAsync", true),
               edm::allowedValues<std::string>("Sync", "Async", "PseudoAsync"));
  if (allowRetry)
    desc.addUntracked<unsigned>("allowedTries", 0);
  desc.addUntracked<bool>("verbose", false);
}

finish()

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

protected

Definition at line 45 of file SonicClientBase.cc.

References allowedTries_, evaluate(), edm::errors::ExternalFailure, holder_, reset(), summarizeEdmComparisonLogfiles::success, and tries_.

Referenced by progressbar.ProgressBar::__next__(), TritonClient::evaluate(), and TritonClient::handle_exception().

                                                                {
  //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 {
      edm::Exception ex(edm::errors::ExternalFailure);
      ex << "SonicCallFailed: call failed after max " << tries_ << " tries";
      eptr = make_exception_ptr(ex);
    }
  }
  if (holder_) {
    holder_->doneWaiting(eptr);
    holder_.reset();
  } else if (eptr)
    std::rethrow_exception(eptr);

  //reset client data now (usually done at end of produce())
  if (eptr)
    reset();
}

mode()

SonicMode SonicClientBase::mode ( void  ) const

inline

Definition at line 28 of file SonicClientBase.h.

References mode_.

Referenced by setMode().

{ return mode_; }

reset()

virtual void SonicClientBase::reset ( void  )

inlinevirtual

Reimplemented in TritonClient.

Definition at line 37 of file SonicClientBase.h.

Referenced by finish().

{}

setMode()

void SonicClientBase::setMode ( SonicMode  mode )

protected

Definition at line 26 of file SonicClientBase.cc.

References Async, dispatcher_, mode(), mode_, or, PseudoAsync, and Sync.

Referenced by SonicClientBase(), and TritonClient::TritonClient().

                                            {
  if (dispatcher_ and mode_ == mode)
    return;
  mode_ = mode;

  //get correct dispatcher for mode
  if (mode_ == SonicMode::Sync or mode_ == SonicMode::Async)
    dispatcher_ = std::make_unique<SonicDispatcher>(this);
  else if (mode_ == SonicMode::PseudoAsync)
    dispatcher_ = std::make_unique<SonicDispatcherPseudoAsync>(this);
}

start() [1/2]

void SonicClientBase::start ( edm::WaitingTaskWithArenaHolder  holder )

protected

Definition at line 38 of file SonicClientBase.cc.

References holder_, eostools::move(), and start().

Referenced by progressbar.ProgressBar::__next__(), SonicDispatcher::dispatch(), and SonicDispatcherPseudoAsync::dispatch().

                                                                {
  start();
  holder_ = std::move(holder);
}

start() [2/2]

void SonicClientBase::start ( )

protected

Definition at line 43 of file SonicClientBase.cc.

References tries_.

Referenced by progressbar.ProgressBar::__next__(), and start().

{ tries_ = 0; }

Friends And Related Function Documentation

SonicDispatcher

friend class SonicDispatcher

friend

Definition at line 63 of file SonicClientBase.h.

SonicDispatcherPseudoAsync

friend class SonicDispatcherPseudoAsync

friend

Definition at line 64 of file SonicClientBase.h.

Member Data Documentation

allowedTries_

unsigned SonicClientBase::allowedTries_

protected

Definition at line 57 of file SonicClientBase.h.

Referenced by finish().

clientName_

std::string SonicClientBase::clientName_

protected

Definition at line 61 of file SonicClientBase.h.

Referenced by clientName(), and SonicClientBase().

debugName_

std::string SonicClientBase::debugName_

protected

Definition at line 61 of file SonicClientBase.h.

Referenced by debugName(), TritonClient::reportServerSideStats(), and TritonClient::TritonClient().

dispatcher_

std::unique_ptr<SonicDispatcher> SonicClientBase::dispatcher_

protected

Definition at line 56 of file SonicClientBase.h.

Referenced by dispatch(), and setMode().

fullDebugName_

std::string SonicClientBase::fullDebugName_

protected

Definition at line 61 of file SonicClientBase.h.

Referenced by TritonClient::reportServerSideStats(), SonicClientBase(), and TritonClient::TritonClient().

holder_

std::optional<edm::WaitingTaskWithArenaHolder> SonicClientBase::holder_

protected

Definition at line 58 of file SonicClientBase.h.

Referenced by finish(), and start().

mode_

SonicMode SonicClientBase::mode_

protected

Definition at line 54 of file SonicClientBase.h.

Referenced by TritonClient::evaluate(), mode(), and setMode().

tries_

unsigned SonicClientBase::tries_

protected

Definition at line 57 of file SonicClientBase.h.

Referenced by TritonClient::evaluate(), finish(), and start().

verbose_

bool SonicClientBase::verbose_

protected

Definition at line 55 of file SonicClientBase.h.