libivon 0.1.0
Voice-over-IP library
Loading...
Searching...
No Matches
ivon::NegotiationError Class Reference

Composite error type for key negotiation failures. More...

#include <ivon_types.hpp>

Public Member Functions

constexpr NegotiationError () noexcept
 
constexpr NegotiationError (NegotiationErrorCode code) noexcept
 
 NegotiationError (NegotiationErrorCode code, std::string detail)
 
constexpr NegotiationError (ConnectionErrorCode code) noexcept
 
 NegotiationError (ConnectionErrorCode code, std::string detail)
 
constexpr bool is_connection_error () const noexcept
 
constexpr bool is_negotiation_error () const noexcept
 
constexpr NegotiationErrorCode negotiation_code () const noexcept
 
constexpr ConnectionErrorCode connection_code () const noexcept
 
constexpr const char * message () const noexcept
 
const std::string & detail () const noexcept
 
constexpr operator bool () const noexcept
 
constexpr bool operator== (NegotiationErrorCode code) const noexcept
 
constexpr bool operator== (ConnectionErrorCode code) const noexcept
 

Detailed Description

Composite error type for key negotiation failures.

Can hold either a negotiation-specific error or a general connection error, since negotiation can fail due to either type of issue.

Constructor & Destructor Documentation

◆ NegotiationError() [1/5]

constexpr ivon::NegotiationError::NegotiationError ( )
inlineconstexprnoexcept

◆ NegotiationError() [2/5]

constexpr ivon::NegotiationError::NegotiationError ( NegotiationErrorCode  code)
inlineexplicitconstexprnoexcept

◆ NegotiationError() [3/5]

ivon::NegotiationError::NegotiationError ( NegotiationErrorCode  code,
std::string  detail 
)
inline

◆ NegotiationError() [4/5]

constexpr ivon::NegotiationError::NegotiationError ( ConnectionErrorCode  code)
inlineexplicitconstexprnoexcept

◆ NegotiationError() [5/5]

ivon::NegotiationError::NegotiationError ( ConnectionErrorCode  code,
std::string  detail 
)
inline

Member Function Documentation

◆ connection_code()

constexpr ConnectionErrorCode ivon::NegotiationError::connection_code ( ) const
inlineconstexprnoexcept

◆ detail()

const std::string & ivon::NegotiationError::detail ( ) const
inlinenoexcept

◆ is_connection_error()

constexpr bool ivon::NegotiationError::is_connection_error ( ) const
inlineconstexprnoexcept

◆ is_negotiation_error()

constexpr bool ivon::NegotiationError::is_negotiation_error ( ) const
inlineconstexprnoexcept

◆ message()

constexpr const char * ivon::NegotiationError::message ( ) const
inlineconstexprnoexcept

◆ negotiation_code()

constexpr NegotiationErrorCode ivon::NegotiationError::negotiation_code ( ) const
inlineconstexprnoexcept

◆ operator bool()

constexpr ivon::NegotiationError::operator bool ( ) const
inlineexplicitconstexprnoexcept

◆ operator==() [1/2]

constexpr bool ivon::NegotiationError::operator== ( ConnectionErrorCode  code) const
inlineconstexprnoexcept

◆ operator==() [2/2]

constexpr bool ivon::NegotiationError::operator== ( NegotiationErrorCode  code) const
inlineconstexprnoexcept

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