ExceptionSvc Class Reference

Simple implementation of IExceptionSvc abstract interface. More...

#include <src/ExceptionSvc.h>

Inheritance diagram for ExceptionSvc:

Collaboration diagram for ExceptionSvc:

Public Member Functions
StatusCode	handle (const INamedInterface &o, const GaudiException &e) const override
	Handle caught GaudiExceptions. More...
StatusCode	handle (const INamedInterface &o, const std::exception &e) const override
	Handle caught std::exceptions. More...
StatusCode	handle (const INamedInterface &o) const override
	Handle caught (unknown)exceptions. More...
StatusCode	handleErr (const INamedInterface &o, const StatusCode &s) const override
	Handle errors. More...
StatusCode	initialize () override
	initialize the service More...
	ExceptionSvc (const std::string &name, ISvcLocator *svc)
	standard constructor More...
	~ExceptionSvc () override=default
	Destructor. More...
Public Member Functions inherited from extends< BASE, Interfaces >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	~extends () override=default
	Virtual destructor. More...
Public Member Functions inherited from extend_interfaces< Interfaces...>
	~extend_interfaces () override=default
	Virtual destructor. More...
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Types
enum	Policy { ALL, NONE }
enum	ReturnState {   SUCCESS, FAILURE, RECOVERABLE, RETHROW,   DEFAULT }

Private Member Functions
	ExceptionSvc ()=delete
	no default constructor More...
	ExceptionSvc (const ExceptionSvc &)=delete
ExceptionSvc &	operator= (const ExceptionSvc &)=delete
virtual StatusCode	process (const INamedInterface &o) const

Private Attributes
Policy	m_mode_exc = ALL
Policy	m_mode_err = NONE
StringProperty	m_mode_exc_s
StringProperty	m_mode_err_s
std::map< std::string, ReturnState >	m_retCodesExc
std::map< std::string, ReturnState >	m_retCodesErr
MsgStream	m_log

Additional Inherited Members
Public Types inherited from extends< BASE, Interfaces >
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
using	base_class = extends
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces...>
	Typedef to the base of this class. More...
Public Types inherited from extend_interfaces< Interfaces...>
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids...>::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Simple implementation of IExceptionSvc abstract interface.

Author

(1) ATLAS collaboration

(2) modified by Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date

2007-03-08

Definition at line 19 of file ExceptionSvc.h.

Member Enumeration Documentation

enum ExceptionSvc::Policy

private

Enumerator
ALL
NONE

Definition at line 60 of file ExceptionSvc.h.

{ ALL, NONE };

enum ExceptionSvc::ReturnState

private

Enumerator
SUCCESS
FAILURE
RECOVERABLE
RETHROW
DEFAULT

Definition at line 61 of file ExceptionSvc.h.

{ SUCCESS, FAILURE, RECOVERABLE, RETHROW, DEFAULT };

Constructor & Destructor Documentation

ExceptionSvc::ExceptionSvc	(	const std::string &	name,
		ISvcLocator *	svc
	)

standard constructor

Parameters

name	service instance name
pSvc	pointer to Service Locator

Definition at line 36 of file ExceptionSvc.cpp.

  : base_class( nam, svc )
  , m_log(msgSvc(), name() )
{
  // for exceptions
  declareProperty( "Catch"      , m_mode_exc_s="ALL" ) ;

  // for return codes
  declareProperty( "Errors"     , m_mode_err_s="NONE" ) ;
}

ExceptionSvc::~ExceptionSvc ( )

overridedefault

Destructor.

ExceptionSvc::ExceptionSvc ( )

privatedelete

no default constructor

ExceptionSvc::ExceptionSvc ( const ExceptionSvc &  )

privatedelete

Member Function Documentation

StatusCode ExceptionSvc::handle ( const INamedInterface &  o, const GaudiException &  e  ) const

override

Handle caught GaudiExceptions.

Handle caught exceptions

Definition at line 230 of file ExceptionSvc.cpp.

{
  m_log << MSG::DEBUG << "Handling GaudiException: \"" << exc << "\" for "
        << alg.name() << endmsg;
  return process(alg);
}

StatusCode ExceptionSvc::handle ( const INamedInterface &  o, const std::exception &  e  ) const

override

Handle caught std::exceptions.

Handle caught exceptions

Definition at line 220 of file ExceptionSvc.cpp.

{
  m_log << MSG::DEBUG << "Handling std:except: \"" << exc.what() << "\" for "
        << alg.name() << endmsg;
  return process(alg) ;
}

StatusCode ExceptionSvc::handle ( const INamedInterface &  o ) const

override

Handle caught (unknown)exceptions.

Handle caught exceptions

Definition at line 211 of file ExceptionSvc.cpp.

{
  m_log << MSG::DEBUG << "Handling unknown exception for " << alg.name()
        << endmsg;
  return process(alg);
}

StatusCode ExceptionSvc::handleErr ( const INamedInterface &  o, const StatusCode &  s  ) const

override

Handle errors.

Handle errors

Definition at line 159 of file ExceptionSvc.cpp.

{
  m_log << MSG::DEBUG << "Handling Error from " << alg.name() << endmsg;

  // is this Alg special?
  auto i = m_retCodesErr.find(alg.name());
  if ( i != m_retCodesErr.end()) {
    switch ( i->second ) {
    case SUCCESS:     return StatusCode::SUCCESS;
    case FAILURE:     return StatusCode::FAILURE;
    case RECOVERABLE: return StatusCode::RECOVERABLE;
      // should never get here
    case RETHROW: break;
    case DEFAULT: break;
    }

  } else {

    if (m_mode_err == ALL) return StatusCode::FAILURE; // turn it into FAILURE
    assert (m_mode_err == NONE );
    // don't touch the return code
    return st;
  }
  return StatusCode::FAILURE;
}

StatusCode ExceptionSvc::initialize ( )

override

initialize the service

Definition at line 50 of file ExceptionSvc.cpp.

                         {
  StatusCode status = Service::initialize();
  m_log.setLevel( m_outputLevel.value() );

  if ( status.isFailure() )  { return status ; }                  // RETURN

  string key = m_mode_exc_s.value();

  auto loc = key.find(" ");
  std::string mode = key.substr(0,loc);

  toupper(mode);

  if (mode == "NONE") {       m_mode_exc = NONE;
  } else if (mode == "ALL") { m_mode_exc = ALL;
  } else {
    m_log << MSG::ERROR << "Unknown mode for Exception handling: \"" << mode
    << "\". Default must be one of \"ALL\" or \"NONE\"" << endmsg;
    m_state = Gaudi::StateMachine::OFFLINE;
    return StatusCode::FAILURE;
  }

  if (loc == string::npos) {
    key.clear();
  } else {
    key = key.substr(loc+1);
  }

  std::string VAL, TAG;

  static const boost::regex exp{"[[:space:]]*([^[:space:]]+)[[:space:]]*=[[:space:]]*([^[:space:]]+)"};
  static const auto tok_end = boost::sregex_iterator();
  for (auto tok_iter = boost::sregex_iterator(begin(key), end(key), exp);
       tok_iter != tok_end; ++tok_iter)
  {
    TAG = (*tok_iter)[1];
    VAL = (*tok_iter)[2];
    toupper(VAL);

    if (VAL == "SUCCESS") {              m_retCodesExc[TAG] = SUCCESS;
    } else if ( VAL == "FAILURE" ) {     m_retCodesExc[TAG] = FAILURE;
    } else if ( VAL == "REVOVERABLE" ) { m_retCodesExc[TAG] = RECOVERABLE;
    } else if ( VAL == "RETHROW" ) {     m_retCodesExc[TAG] = RETHROW;
    } else if ( VAL == "DEFAULT" ) {     m_retCodesExc[TAG] = DEFAULT;
    } else {
      m_log << MSG::ERROR << "In JobOpts: unknown return code \"" << VAL
            << "\" for Algorithm " << TAG << std::endl
            << "   Must be one of: DEFAULT, SUCCESS, FAILURE, RECOVERABLE, RETHROW"
            << endmsg;
      m_state = Gaudi::StateMachine::OFFLINE;
      return StatusCode::FAILURE;
    }

    m_log << MSG::DEBUG << "Will catch exceptions thrown by: " << TAG
          << " -> action: " << VAL << endmsg;

  }

  // now process errors
  key = m_mode_err_s.value();

  loc = key.find(" ");
  mode = key.substr(0,loc);

  toupper(mode);

  if (mode == "NONE") {       m_mode_err = NONE;
  } else if (mode == "ALL") { m_mode_err = ALL;
  } else {
    m_log << MSG::ERROR << "Unknown mode for Error handling: \"" << mode
          << "\". Default must be one of \"ALL\" or \"NONE\"" << endmsg;
    m_state = Gaudi::StateMachine::OFFLINE;
    return StatusCode::FAILURE;
  }

  if (loc == string::npos) {
    key.clear();
  } else {
    key = key.substr(loc+1);
  }

  for (auto tok_iter = boost::sregex_iterator(begin(key), end(key), exp);
       tok_iter != tok_end; ++tok_iter)
  {
    TAG = (*tok_iter)[1];
    VAL = (*tok_iter)[2];
    toupper(VAL);

    if (VAL == "SUCCESS") {              m_retCodesErr[TAG] = SUCCESS;
    } else if ( VAL == "FAILURE" ) {     m_retCodesErr[TAG] = FAILURE;
    } else if ( VAL == "RECOVERABLE" ) { m_retCodesErr[TAG] = RECOVERABLE;
    } else {
      m_log << MSG::ERROR << "In JobOpts: unknown return code \"" << VAL
            << "\" for Algorithm " << TAG << std::endl
            << "   Must be one of: SUCCESS, FAILURE, RECOVERABLE"
            << endmsg;
      m_state = Gaudi::StateMachine::OFFLINE;
      return StatusCode::FAILURE;
    }

    m_log << MSG::DEBUG << "Will process Errors returned by: " << TAG
          << " -> action: " << VAL << endmsg;
  }
  return status;
}

ExceptionSvc& ExceptionSvc::operator= ( const ExceptionSvc &  )

privatedelete

StatusCode ExceptionSvc::process ( const INamedInterface &  o ) const

privatevirtual

Definition at line 188 of file ExceptionSvc.cpp.

{

  // is this Alg special?
  auto i = m_retCodesExc.find(alg.name());
  if ( i != m_retCodesExc.end()) {

    switch ( i->second ) {
    case DEFAULT:     return StatusCode::FAILURE; // there is no default
    case SUCCESS:     return StatusCode::SUCCESS;
    case FAILURE:     return StatusCode::FAILURE;
    case RECOVERABLE: return StatusCode::RECOVERABLE;
    case RETHROW:     throw;
    }
  } 

  if (m_mode_exc == ALL) { throw; }
  assert (m_mode_exc == NONE);
  return StatusCode::FAILURE;
}

Member Data Documentation

MsgStream ExceptionSvc::m_log

mutableprivate

Definition at line 67 of file ExceptionSvc.h.

Policy ExceptionSvc::m_mode_err = NONE

private

Definition at line 63 of file ExceptionSvc.h.

StringProperty ExceptionSvc::m_mode_err_s

private

Definition at line 64 of file ExceptionSvc.h.

Policy ExceptionSvc::m_mode_exc = ALL

private

Definition at line 63 of file ExceptionSvc.h.

StringProperty ExceptionSvc::m_mode_exc_s

private

Definition at line 64 of file ExceptionSvc.h.

std::map<std::string,ReturnState> ExceptionSvc::m_retCodesErr

private

Definition at line 65 of file ExceptionSvc.h.

std::map<std::string,ReturnState> ExceptionSvc::m_retCodesExc

private

Definition at line 65 of file ExceptionSvc.h.

---

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

• GaudiMonitor/src/ExceptionSvc.h
• GaudiMonitor/src/ExceptionSvc.cpp