# VerificationErrorDetails

<a id="verificationerrordetails"></a>

# VerificationErrorDetails

```cpp
#include <icy/net/sslmanager.h>

class VerificationErrorDetails
```

[Defined in src/net/include/icy/net/sslmanager.h:134](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L134)

A utility class for certificate error handling.

## Public Methods

| Return | Name | Description |
|--------|------|-------------|
|  | [`VerificationErrorDetails`](#verificationerrordetails-1)  | Creates the [VerificationErrorDetails](#verificationerrordetails). _ignoreError is per default set to false. |
|  | [`~VerificationErrorDetails`](#verificationerrordetails-2) `noexcept` | Destroys the [VerificationErrorDetails](#verificationerrordetails). |
| const [`crypto::X509Certificate`](https://auscaster.com/icey/docs/api-reference/icy-crypto-X509Certificate.md#x509certificate) & | [`certificate`](#certificate) `const` `inline` | Returns the certificate that caused the error. |
| `int` | [`errorDepth`](#errordepth) `const` `inline` | Returns the position of the certificate in the certificate chain. |
| `int` | [`errorNumber`](#errornumber) `const` `inline` | Returns the id of the error. |
| `const std::string &` | [`errorMessage`](#errormessage) `const` `inline` | Returns the textual presentation of the errorNumber. |
| `void` | [`setIgnoreError`](#setignoreerror) `inline` | setIgnoreError to true, if a verification error is judged non-fatal by the user. |
| `bool` | [`getIgnoreError`](#getignoreerror) `const` `inline` | returns the value of _ignoreError |

---

<a id="verificationerrordetails-1"></a>

### VerificationErrorDetails

```cpp
VerificationErrorDetails(const crypto::X509Certificate & cert, int errDepth, int errNum, const std::string & errMsg)
```

[Defined in src/net/include/icy/net/sslmanager.h:139](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L139)

Creates the [VerificationErrorDetails](#verificationerrordetails). _ignoreError is per default set to false.

---

<a id="verificationerrordetails-2"></a>

### ~VerificationErrorDetails

`noexcept`

```cpp
~VerificationErrorDetails() noexcept
```

[Defined in src/net/include/icy/net/sslmanager.h:143](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L143)

Destroys the [VerificationErrorDetails](#verificationerrordetails).

---

<a id="certificate"></a>

### certificate

`const` `inline`

```cpp
inline const crypto::X509Certificate & certificate() const
```

[Defined in src/net/include/icy/net/sslmanager.h:146](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L146)

Returns the certificate that caused the error.

---

<a id="errordepth"></a>

### errorDepth

`const` `inline`

```cpp
inline int errorDepth() const
```

[Defined in src/net/include/icy/net/sslmanager.h:149](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L149)

Returns the position of the certificate in the certificate chain.

---

<a id="errornumber"></a>

### errorNumber

`const` `inline`

```cpp
inline int errorNumber() const
```

[Defined in src/net/include/icy/net/sslmanager.h:152](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L152)

Returns the id of the error.

---

<a id="errormessage"></a>

### errorMessage

`const` `inline`

```cpp
inline const std::string & errorMessage() const
```

[Defined in src/net/include/icy/net/sslmanager.h:155](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L155)

Returns the textual presentation of the errorNumber.

---

<a id="setignoreerror"></a>

### setIgnoreError

`inline`

```cpp
inline void setIgnoreError(bool ignoreError)
```

[Defined in src/net/include/icy/net/sslmanager.h:159](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L159)

setIgnoreError to true, if a verification error is judged non-fatal by the user.

---

<a id="getignoreerror"></a>

### getIgnoreError

`const` `inline`

```cpp
inline bool getIgnoreError() const
```

[Defined in src/net/include/icy/net/sslmanager.h:162](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L162)

returns the value of _ignoreError

## Private Attributes

| Return | Name | Description |
|--------|------|-------------|
| [`crypto::X509Certificate`](https://auscaster.com/icey/docs/api-reference/icy-crypto-X509Certificate.md#x509certificate) | [`_cert`](#_cert)  |  |
| `int` | [`_errorDepth`](#_errordepth)  |  |
| `int` | [`_errorNumber`](#_errornumber)  |  |
| `std::string` | [`_errorMessage`](#_errormessage)  |  |
| `bool` | [`_ignoreError`](#_ignoreerror)  |  |

---

<a id="_cert"></a>

### _cert

```cpp
crypto::X509Certificate _cert
```

Type: [`crypto::X509Certificate`](https://auscaster.com/icey/docs/api-reference/icy-crypto-X509Certificate.md#x509certificate)

[Defined in src/net/include/icy/net/sslmanager.h:165](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L165)

---

<a id="_errordepth"></a>

### _errorDepth

```cpp
int _errorDepth
```

[Defined in src/net/include/icy/net/sslmanager.h:166](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L166)

---

<a id="_errornumber"></a>

### _errorNumber

```cpp
int _errorNumber
```

[Defined in src/net/include/icy/net/sslmanager.h:167](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L167)

---

<a id="_errormessage"></a>

### _errorMessage

```cpp
std::string _errorMessage
```

[Defined in src/net/include/icy/net/sslmanager.h:168](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L168)

---

<a id="_ignoreerror"></a>

### _ignoreError

```cpp
bool _ignoreError
```

[Defined in src/net/include/icy/net/sslmanager.h:169](https://github.com/auscaster/icey/blob/main/src/net/include/icy/net/sslmanager.h#L169)
