EII Message Bus C Reference
Public Member Functions | List of all members
eii::msgbus::MsgbusException Class Reference

#include <msg_envelope.hpp>

Inheritance diagram for eii::msgbus::MsgbusException:

Public Member Functions

 MsgbusException (msgbus_ret_t ret, const char *msg)
 
const char * what () const noexcept override
 
msgbus_ret_t get_msgbus_ret ()
 

Detailed Description

Exception thrown by the EII Message envelope APIs indicating an error occurred in the called method.

Constructor & Destructor Documentation

◆ MsgbusException()

eii::msgbus::MsgbusException::MsgbusException ( msgbus_ret_t  ret,
const char *  msg 
)

Constructor

Parameters
ret- Message bus return code
msg- Extra message with the exception

Member Function Documentation

◆ get_msgbus_ret()

msgbus_ret_t eii::msgbus::MsgbusException::get_msgbus_ret ( )

Returns the msgbus_ret_t indicating the error type.

Returns
msgbus_ret_t

◆ what()

const char* eii::msgbus::MsgbusException::what ( ) const
inlineoverridenoexcept

Returns the explanatory string.

Returns
Pointer to null-terminated explanation string

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