DelegateResponseError Class Reference

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

#include <mip/error.h>

Inheritance diagram for DelegateResponseError:

Public Member Functions
	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, 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, 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)
	Creates an error/exception object. Call this method from a MIP delegate function to create a generic MIP C++ exception object.
	DelegateResponseError (const Error &error)
std::shared_ptr< Error >	Clone () const override
	Clone the error.
ErrorType	GetErrorType () const override
	Get the error type.
const std::exception_ptr &	GetExceptionPtr () const
Public Member Functions inherited from Error
char const *	what () const noexcept override
	Get the error message.
const std::string &	GetErrorName () const
	Get the error name.
const std::string &	GetMessage (bool maskPII=false) const
	Get the error message.
void	SetMessage (const std::string &msg)
	Set the error message.
void	AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
	Add debug info entry.
const std::map< std::string, std::string > &	GetDebugInfo () const
	Get debug info.
virtual	~Error ()

Private Attributes
std::exception_ptr	mCurrentException

Additional Inherited Members
Protected Member Functions inherited from Error
	Error (const std::string &message, const std::string &name, ErrorType type)
	Error (const std::string &message, const std::map< std::string, std::string > debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name, ErrorType type)
Protected Attributes inherited from Error
std::string	mMessage
std::map< std::string, std::string >	mDebugInfo
std::string	mName
ErrorType	mType

Detailed Description

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

Constructor & Destructor Documentation

DelegateResponseError() [1/6]

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.

DelegateResponseError() [2/6]

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.

DelegateResponseError() [3/6]

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.

DelegateResponseError() [4/6]

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.

DelegateResponseError() [5/6]

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.

DelegateResponseError() [6/6]

DelegateResponseError::DelegateResponseError ( const Error & error )

inlineexplicit

Member Function Documentation

Clone()

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

inlineoverridevirtual

Clone the error.

Returns

a clone of the error.

Implements Error.

GetErrorType()

ErrorType DelegateResponseError::GetErrorType ( ) const

inlineoverridevirtual

Get the error type.

Returns

the error type.

Reimplemented from Error.

GetExceptionPtr()

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

inline

Member Data Documentation

mCurrentException

std::exception_ptr DelegateResponseError::mCurrentException

private

---

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

• src/api/mip/error.h