Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
|
Networking error. More...
#include <src/api/mip/error.h>
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 |
Networking error.
Caused by unexpected behavior when making network calls to service endpoints.
|
strong |
Category of network error.
Definition at line 467 of file error.h.
|
inlineinherited |
Add debug info entry.
key | Debug info key |
value | Debug info value |
Definition at line 179 of file error.h.
References Error::mDebugInfo.
Referenced by DelegateResponseError::DelegateResponseError(), DelegateResponseError::DelegateResponseError(), and DelegateResponseError::DelegateResponseError().
|
pure virtualinherited |
|
inline |
|
inlineinherited |
Get debug info.
Definition at line 192 of file error.h.
References Error::mDebugInfo.
|
inlineinherited |
Get the error name.
Definition at line 144 of file error.h.
References Error::mName.
|
inlinevirtualinherited |
Get the error type.
Definition at line 137 of file error.h.
References Error::mType.
|
inlineinherited |
|
inline |
|
inlineinherited |
Set the error message.
msg | the error message. |
Definition at line 160 of file error.h.
References Error::mMessage.
|
inlineoverridenoexceptinherited |
|
inherited |
Definition at line 225 of file error.h.
Referenced by Error::AddDebugInfo(), and Error::GetDebugInfo().
|
inherited |
Definition at line 224 of file error.h.
Referenced by DelegateResponseError::DelegateResponseError(), and Error::SetMessage().
|
inherited |
Definition at line 226 of file error.h.
Referenced by Error::GetErrorName().
|
inherited |
Definition at line 227 of file error.h.
Referenced by Error::GetErrorType().