Networking error. Caused by unexpected behavior when making network calls to service endpoints. More...

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

Inheritance diagram for NetworkError:

[legend]

Collaboration diagram for NetworkError:

[legend]

Public Types
enum class	Category { Unknown = 0 , FailureResponseCode = 1 , BadResponse = 2 , UnexpectedResponse = 3 , NoConnection = 4 , Proxy = 5 , SSL = 6 , Timeout = 7 , Offline = 8 , Throttled = 9 , Cancelled = 10 , FunctionNotImplemented = 11 , ServiceUnavailable = 12 }
	Category of network error. More...

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.

Category	GetCategory () const
	Gets the category of network failure.

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.

int32_t	GetResponseStatusCode () const
	Gets the HTTP response status code.

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

Private Member Functions
std::string	CreateFormattedMessage (const std::string &message) const

const std::string &	GetCategoryString (Category category) const

Private Attributes
Category	mCategory

std::string	mFormattedMessage

std::string	mMaskedMessage

int32_t	mResponseStatusCode

Detailed Description

Networking error. Caused by unexpected behavior when making network calls to service endpoints.

Definition at line 462 of file error.h.

Member Enumeration Documentation

◆ Category

enum class NetworkError::Category

strong

Category of network error.

Enumerator
Unknown	Unknown network failure
FailureResponseCode	HTTP response code indicates failure
BadResponse	HTTP response could not be read
UnexpectedResponse	HTTP response completed but contained unexpected data
NoConnection	Failed to establish a connection
Proxy	Proxy failure
SSL	SSL failure
Timeout	Connection timed out
Offline	Operation requires network connectivity
Throttled	HTTP operation failed due to server traffic throttling
Cancelled	HTTP operation has been cancelled by the application
FunctionNotImplemented	HTTP response code indicates called function is not implemented
ServiceUnavailable	HTTP response code indicates service is unavailable

Definition at line 467 of file error.h.

                      {
    Unknown = 0, /**< Unknown network failure */
    FailureResponseCode = 1, /**< HTTP response code indicates failure */
    BadResponse = 2, /**< HTTP response could not be read */
    UnexpectedResponse = 3, /**< HTTP response completed but contained unexpected data */
    NoConnection = 4, /**< Failed to establish a connection */
    Proxy = 5, /**< Proxy failure */
    SSL = 6, /**< SSL failure */
    Timeout = 7, /**< Connection timed out */
    Offline = 8, /**< Operation requires network connectivity */
    Throttled = 9, /**< HTTP operation failed due to server traffic throttling */
    Cancelled = 10, /**< HTTP operation has been cancelled by the application */
    FunctionNotImplemented = 11, /**< HTTP response code indicates called function is not implemented */
    ServiceUnavailable = 12, /**< HTTP response code indicates service is unavailable */
  };

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, Error::mFormattedMessage, and Error::mMaskedMessage.

Referenced by NoPermissionsExtendedError::AddExtendedErrorInfoToDebugInfo(), DelegateResponseError::DelegateResponseError(), DelegateResponseError::DelegateResponseError(), and DelegateResponseError::DelegateResponseError().

◆ Clone()

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

pure virtualinherited

Clone the error.

Returns: a clone of the error.

Implemented in JustificationRequiredError.

◆ CreateFormattedMessage()

std::string Error::CreateFormattedMessage ( const std::string & message ) const

inlineprivateinherited

Definition at line 230 of file error.h.

                                                                   {
    auto formattedMessage = message;
 
    // Remove stray newlines
    auto isNewlineFn = [](char c) { return c == '\n' || c == '\r'; };
    formattedMessage.erase(std::remove_if(formattedMessage.begin(), formattedMessage.end(), isNewlineFn), formattedMessage.end());
 
    return formattedMessage;
  }

◆ GetCategory()

Category NetworkError::GetCategory ( ) const

inline

Gets the category of network failure.

Returns: Category of network failure

Definition at line 523 of file error.h.

523{ return mCategory; }

NetworkError::mCategory

Category mCategory

Definition error.h:533

References mCategory.

◆ GetCategoryString()

const std::string & NetworkError::GetCategoryString ( Category category ) const

inlineprivate

Definition at line 536 of file error.h.

                                                              {
    static const std::string kUnrecognized = "UNRECOGNIZED";
    static const std::map<Category, std::string> kCategories = {
        { Category::Unknown,             "Unknown" },
        { Category::FailureResponseCode, "FailureResponseCode" },
        { Category::BadResponse,         "BadResponse" },
        { Category::UnexpectedResponse,  "UnexpectedResponse" },
        { Category::NoConnection,        "NoConnection" },
        { Category::Proxy,               "Proxy" },
        { Category::SSL,                 "SSL" },
        { Category::Timeout,             "Timeout" },
        { Category::Offline,             "Offline" },
        { Category::Throttled,           "Throttled" },
        { Category::ServiceUnavailable,  "ServiceUnavailable" },
        { Category::Cancelled,           "Cancelled" },
    };
    return kCategories.count(category) ? kCategories.at(category) : kUnrecognized;
  }

References BadResponse, Cancelled, FailureResponseCode, NoConnection, Offline, Proxy, ServiceUnavailable, SSL, Throttled, Timeout, UnexpectedResponse, and Unknown.

◆ 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;
  }

References Error::mFormattedMessage, and Error::mMaskedMessage.

◆ GetResponseStatusCode()

int32_t NetworkError::GetResponseStatusCode ( ) const

inline

Gets the HTTP response status code.

Returns: HTTP response status code, 0 if none

Definition at line 530 of file error.h.

530{ return mResponseStatusCode; }

NetworkError::mResponseStatusCode

int32_t mResponseStatusCode

Definition error.h:534

References mResponseStatusCode.

◆ 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::mFormattedMessage, Error::mMaskedMessage, and 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();
  }

References Error::mFormattedMessage.

Member Data Documentation

◆ mCategory

Category NetworkError::mCategory

private

Definition at line 533 of file error.h.

Referenced by GetCategory().

◆ 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().

◆ mFormattedMessage

std::string Error::mFormattedMessage

privateinherited

Definition at line 240 of file error.h.

Referenced by Error::AddDebugInfo(), Error::GetMessage(), Error::SetMessage(), and Error::what().

◆ mMaskedMessage

std::string Error::mMaskedMessage

privateinherited

Definition at line 241 of file error.h.

Referenced by Error::AddDebugInfo(), Error::GetMessage(), and Error::SetMessage().

◆ mMessage

std::string Error::mMessage

inherited

Definition at line 224 of file error.h.

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

◆ mName

std::string Error::mName

inherited

Definition at line 226 of file error.h.

Referenced by Error::GetErrorName().

◆ mResponseStatusCode

int32_t NetworkError::mResponseStatusCode

private

Definition at line 534 of file error.h.

Referenced by GetResponseStatusCode().

◆ 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 Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Category

Member Function Documentation

◆ AddDebugInfo()

◆ Clone()

◆ CreateFormattedMessage()

◆ GetCategory()

◆ GetCategoryString()

◆ GetDebugInfo()

◆ GetErrorName()

◆ GetErrorType()

◆ GetMessage()

◆ GetResponseStatusCode()

◆ SetMessage()

◆ what()

Member Data Documentation

◆ mCategory

◆ mDebugInfo

◆ mFormattedMessage

◆ mMaskedMessage

◆ mMessage

◆ mName

◆ mResponseStatusCode

◆ mType