async_mqtt 5.0.0
Loading...
Searching...
No Matches
async_mqtt::system_error Struct Reference

async_mqtt error class. It is used as CompletionToken parameter and exception. More...

#include <exception.hpp>

Inherits boost::system::system_error, and boost::totally_ordered< system_error >.

Public Member Functions

 system_error (error_code const &ec=error_code())
 constructor
 
std::string message () const
 get error message If you want to more detaied error message, call what() instead.
 
 operator bool () const
 bool operator
 

Related Symbols

(Note that these are not member symbols.)

template<typename WhatArg >
system_error make_error (errc::errc_t ec, WhatArg &&wa)
 system_error factory function
 

Detailed Description

async_mqtt error class. It is used as CompletionToken parameter and exception.

Constructor & Destructor Documentation

◆ system_error()

async_mqtt::system_error::system_error ( error_code const & ec = error_code())
inline

constructor

Parameters
ecerror code. If omit, then no error (success).

Member Function Documentation

◆ message()

std::string async_mqtt::system_error::message ( ) const
inline

get error message If you want to more detaied error message, call what() instead.

Returns
error message string

◆ operator bool()

async_mqtt::system_error::operator bool ( ) const
inline

bool operator

Returns
if error then true, otherwise false.

Friends And Related Symbol Documentation

◆ make_error()

template<typename WhatArg >
system_error make_error ( errc::errc_t ec,
WhatArg && wa )
related

system_error factory function

Parameters
ecerror code.
wadetailed error message that is gotten by system_error::what().
Returns
system_error

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