ADTF
Loading...
Searching...
No Matches
adtf::base::IErrorHandling Class Referenceabstract

#include <error_handling_intf.h>

Inherits adtf::ucom::ant::IObject.

Classes

class  IErrorHandler
 

Public Types

enum class  tAction : uint32_t {
  Ignore = 0 , Log , Stop , Shutdown ,
  Abort
}
 

Public Member Functions

 ADTF_IID (IErrorHandling, "error_handling.elasto.services.adtf.iid")
 
virtual tResult CreateErrorHandler (const char *strErrorSource, const char *strErrorCategory, tAction eDefaultAction, ucom::ant::iobject_ptr< IErrorHandler > &pHandler)=0
 
- Public Member Functions inherited from adtf::ucom::ant::IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 

Additional Inherited Members

- Protected Member Functions inherited from adtf::ucom::ant::IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Detailed Description

Error handling interface.

Please use create_error_handler(), instead of using this interface directly.

Member Enumeration Documentation

◆ tAction

enum class adtf::base::elasto::IErrorHandling::tAction : uint32_t
strong

Predefined actions that are supported by the default error handler implementation.

Enumerator
Ignore 

do nothing.

Log 

log as warning.

Stop 

log error and stop the session.

Shutdown 

log error and shutdown ADTF.

Abort 

abort and create a stack trace.

Member Function Documentation

◆ CreateErrorHandler()

virtual tResult adtf::base::elasto::IErrorHandling::CreateErrorHandler ( const char * strErrorSource,
const char * strErrorCategory,
tAction eDefaultAction,
ucom::ant::iobject_ptr< IErrorHandler > & pHandler )
pure virtual

Creates a new error handler for the given source and category.

Parameters
[in]strErrorSourceThe name of the error source.
[in]strErrorCategoryThe name of the error category.
[in]eDefaultActionThe default action that should be taken if an error occurs.
[out]pHandlerThe new handler.
Returns
Standard result.

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