OpenVPN 3 Core Library
Loading...
Searching...
No Matches
openvpn::ExceptionCode Class Reference

#include <excode.hpp>

Inheritance diagram for openvpn::ExceptionCode:
[legend]
Collaboration diagram for openvpn::ExceptionCode:
[legend]

Public Member Functions

 ExceptionCode ()=default
 
 ExceptionCode (const Error::Type code)
 
 ExceptionCode (const Error::Type code, const bool fatal)
 
void set_code (const Error::Type code)
 
void set_code (const Error::Type code, const bool fatal)
 
Error::Type code () const
 
bool fatal () const
 
bool code_defined () const
 
bool is_tls_alert () const
 Some errors may justify letting the underlying SSL library send out TLS alerts.
 
virtual ~ExceptionCode () noexcept=default
 

Private Attributes

Error::Type code_ = Error::SUCCESS
 
bool fatal_ = false
 

Detailed Description

Definition at line 23 of file excode.hpp.

Constructor & Destructor Documentation

◆ ExceptionCode() [1/3]

openvpn::ExceptionCode::ExceptionCode ( )
default

◆ ExceptionCode() [2/3]

openvpn::ExceptionCode::ExceptionCode ( const Error::Type  code)
inline

Definition at line 27 of file excode.hpp.

◆ ExceptionCode() [3/3]

openvpn::ExceptionCode::ExceptionCode ( const Error::Type  code,
const bool  fatal 
)
inline

Definition at line 31 of file excode.hpp.

◆ ~ExceptionCode()

virtual openvpn::ExceptionCode::~ExceptionCode ( )
virtualdefaultnoexcept

Member Function Documentation

◆ code()

Error::Type openvpn::ExceptionCode::code ( ) const
inline

Definition at line 47 of file excode.hpp.

Here is the caller graph for this function:

◆ code_defined()

bool openvpn::ExceptionCode::code_defined ( ) const
inline

Definition at line 56 of file excode.hpp.

Here is the caller graph for this function:

◆ fatal()

bool openvpn::ExceptionCode::fatal ( ) const
inline

Definition at line 51 of file excode.hpp.

Here is the caller graph for this function:

◆ is_tls_alert()

bool openvpn::ExceptionCode::is_tls_alert ( ) const
inline

Some errors may justify letting the underlying SSL library send out TLS alerts.

Definition at line 62 of file excode.hpp.

Here is the caller graph for this function:

◆ set_code() [1/2]

void openvpn::ExceptionCode::set_code ( const Error::Type  code)
inline

Definition at line 36 of file excode.hpp.

Here is the caller graph for this function:

◆ set_code() [2/2]

void openvpn::ExceptionCode::set_code ( const Error::Type  code,
const bool  fatal 
)
inline

Definition at line 41 of file excode.hpp.

Member Data Documentation

◆ code_

Error::Type openvpn::ExceptionCode::code_ = Error::SUCCESS
private

Definition at line 70 of file excode.hpp.

◆ fatal_

bool openvpn::ExceptionCode::fatal_ = false
private

Definition at line 71 of file excode.hpp.


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