Delegate Response Error. Thrown or returned in response to encountering an error in a delegate method. More...

#include <src/api/mip/error.h>

Inheritance diagram for DelegateResponseError:

[legend]

Collaboration diagram for DelegateResponseError:

[legend]

Public Member Functions
void	AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
	Add debug info entry.

virtual std::shared_ptr< Error >	Clone () const =0
	Clone the error.

	DelegateResponseError (const std::exception_ptr &except)
	Creates an error/exception object. Call this method from a MIP delegate function to create a MIP or standard C++ exception object.

	DelegateResponseError (const std::string &message)
	Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

	DelegateResponseError (const std::string &message, const std::string &stackTrace, const std::string &name="DelegateResponseError")
	Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

	DelegateResponseError (const std::string &message, long HResult)
	Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

	DelegateResponseError (const std::string &message, long HResult, const std::string &stackTrace, const std::string &name="DelegateResponseError")
	Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

const std::map< std::string, std::string > &	GetDebugInfo () const
	Get debug info.

const std::string &	GetErrorName () const
	Get the error name.

virtual ErrorType	GetErrorType () const
	Get the error type.

const std::string &	GetMessage (bool maskPII=false) const
	Get the error message.

void	SetMessage (const std::string &msg)
	Set the error message.

char const *	what () const noexcept override
	Get the error message.

Public Attributes
std::map< std::string, std::string >	mDebugInfo

std::string	mMessage

std::string	mName

ErrorType	mType

Detailed Description

Delegate Response Error. Thrown or returned in response to encountering an error in a delegate method.

Definition at line 315 of file error.h.

Constructor & Destructor Documentation

◆ DelegateResponseError() [1/5]

DelegateResponseError::DelegateResponseError ( const std::exception_ptr & except )

inlineexplicit

Creates an error/exception object. Call this method from a MIP delegate function to create a MIP or standard C++ exception object.

Parameters

except The C++ exception that was encountered.

Definition at line 323 of file error.h.

                                                                 :
      Error(std::string(), std::string("DelegateResponseError"), ErrorType::DELEGATE_RESPONSE),
      mCurrentException(except) {
    if (except) {
      try {
        std::rethrow_exception(except);
      } catch(const Error& error) {
        *static_cast<Error*>(this) = error;
      } catch (const std::exception& thisException) {
        this->mMessage = std::string(thisException.what());
      }
    }
  }

References Error::mMessage.

◆ DelegateResponseError() [2/5]

DelegateResponseError::DelegateResponseError	(	const std::string &	message,
		const std::string &	stackTrace,
		const std::string &	name = "DelegateResponseError" )

inline

Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

Parameters

message	Message associated with the exception.
stackTrace	The stack trace at the time of the exception.
name	Some string to uniquely identify the type of this exception.

Definition at line 345 of file error.h.

      : Error(message, name, ErrorType::DELEGATE_RESPONSE) {
    AddDebugInfo(GetStackTraceString(), stackTrace);
  }

References Error::AddDebugInfo(), and anonymous_namespace{error.h}::GetStackTraceString().

◆ DelegateResponseError() [3/5]

DelegateResponseError::DelegateResponseError	(	const std::string &	message,
		long	HResult,
		const std::string &	stackTrace,
		const std::string &	name = "DelegateResponseError" )

inline

Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

Parameters

message	Message associated with the exception.
HResult	HResult that identifies the error that caused this exception.
stackTrace	The stack trace at the time of the exception.
name	Some string to uniquely identify the type of this exception.

Definition at line 362 of file error.h.

      : Error(message, name, ErrorType::DELEGATE_RESPONSE) {
    std::stringstream hrStream;
    hrStream << std::hex << HResult;
    AddDebugInfo(GetHResultString(), hrStream.str());
    AddDebugInfo(GetStackTraceString(), stackTrace);
  }

References Error::AddDebugInfo(), anonymous_namespace{error.h}::GetHResultString(), and anonymous_namespace{error.h}::GetStackTraceString().

◆ DelegateResponseError() [4/5]

DelegateResponseError::DelegateResponseError	(	const std::string &	message,
		long	HResult )

inline

Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

Parameters

message	Message associated with the exception.
HResult	HResult that identifies the error that caused this exception.

Definition at line 381 of file error.h.

      : Error(message, std::string("DelegateResponseError"), ErrorType::DELEGATE_RESPONSE) {
    std::stringstream hrStream;
    hrStream << std::hex << HResult;
    AddDebugInfo(GetHResultString(), hrStream.str());
  }

References Error::AddDebugInfo(), and anonymous_namespace{error.h}::GetHResultString().

◆ DelegateResponseError() [5/5]

DelegateResponseError::DelegateResponseError ( const std::string & message )

inline

Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.

Parameters

message Message associated with the exception.

Definition at line 394 of file error.h.

395 : Error(message, std::string("DelegateResponseError"), ErrorType::DELEGATE_RESPONSE) {

396 }

Member Function Documentation

◆ AddDebugInfo()

void Error::AddDebugInfo	(	const std::string &	key,
		const std::string &	value,
		bool	sensitive = false )

inlineinherited

Add debug info entry.

Parameters

key	Debug info key
value	Debug info value

Definition at line 179 of file error.h.

                                                                                          {
    if (!key.empty() && !value.empty()) {
      mDebugInfo[key] = value;
      mFormattedMessage = mFormattedMessage + ", " + key + "=" + value;
      mMaskedMessage = mMaskedMessage + ", " + key + "=" + (sensitive ? "***" : value);
    }
  }

References Error::mDebugInfo.

Referenced by DelegateResponseError(), DelegateResponseError(), and DelegateResponseError().

◆ Clone()

virtual std::shared_ptr< Error > Error::Clone ( ) const

pure virtualinherited

Clone the error.

Returns: a clone of the error.

Implemented in JustificationRequiredError.

◆ GetDebugInfo()

const std::map< std::string, std::string > & Error::GetDebugInfo ( ) const

inlineinherited

Get debug info.

Returns: Debug info (keys/values)

Definition at line 192 of file error.h.

192{ return mDebugInfo; }

References Error::mDebugInfo.

◆ GetErrorName()

const std::string & Error::GetErrorName ( ) const

inlineinherited

Get the error name.

Returns: the error name.

Definition at line 144 of file error.h.

144{ return mName; }

Error::mName

std::string mName

Definition error.h:226

References Error::mName.

◆ GetErrorType()

virtual ErrorType Error::GetErrorType ( ) const

inlinevirtualinherited

Get the error type.

Returns: the error type.

Definition at line 137 of file error.h.

137{ return mType; }

Error::mType

ErrorType mType

Definition error.h:227

References Error::mType.

◆ GetMessage()

const std::string & Error::GetMessage ( bool maskPII = false ) const

inlineinherited

Get the error message.

Returns: the error message.

Definition at line 151 of file error.h.

                                                          {
    return maskPII ? mMaskedMessage : mFormattedMessage;
  }

◆ SetMessage()

void Error::SetMessage ( const std::string & msg )

inlineinherited

Set the error message.

Parameters

msg	the error message.

Definition at line 160 of file error.h.

                                        {
    std::string* targetStrings[] = { &mFormattedMessage, &mMaskedMessage };
    for (auto* targetString : targetStrings) {
      size_t pos = targetString->find(mMessage);
      if (pos != std::string::npos) {
        targetString->replace(pos, mMessage.length(), msg);
      } else {
        targetString->replace(0, 0, msg);
      }
    }
    mMessage = msg;
  }

References Error::mMessage.

◆ what()

char const * Error::what ( ) const

inlineoverridenoexceptinherited

Get the error message.

Returns: the error message

Definition at line 121 of file error.h.

                                             {
    return mFormattedMessage.c_str();
  }

Member Data Documentation

◆ mDebugInfo

std::map<std::string, std::string> Error::mDebugInfo

inherited

Definition at line 225 of file error.h.

Referenced by Error::AddDebugInfo(), and Error::GetDebugInfo().

◆ mMessage

std::string Error::mMessage

inherited

Definition at line 224 of file error.h.

Referenced by DelegateResponseError(), and Error::SetMessage().

◆ mName

std::string Error::mName

inherited

Definition at line 226 of file error.h.

Referenced by Error::GetErrorName().

◆ mType

ErrorType Error::mType

inherited

Definition at line 227 of file error.h.

Referenced by Error::GetErrorType().

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

src/api/mip/error.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DelegateResponseError() [1/5]

◆ DelegateResponseError() [2/5]

◆ DelegateResponseError() [3/5]

◆ DelegateResponseError() [4/5]

◆ DelegateResponseError() [5/5]

Member Function Documentation

◆ AddDebugInfo()

◆ Clone()

◆ GetDebugInfo()

◆ GetErrorName()

◆ GetErrorType()

◆ GetMessage()

◆ SetMessage()

◆ what()

Member Data Documentation

◆ mDebugInfo

◆ mMessage

◆ mName

◆ mType