Inheritance diagram for bfn::general_exception:

Public Member Functions
	general_exception () noexcept=default

	~general_exception () override=default

const char *	what () const noexcept override

virtual std::ostream &	print (std::ostream &os) const

Detailed Description

The following defines a general exception used in Bareflank. This should not be thrown and instead, an exception that inherits from this should be thrown that provides more decent output. This exception type can however be inherited from, and caught. There are two main reasons why this exception is used instead of using std::exception directly:

std::exception uses 'what()' to provide information about what was thrown which returns a const char *. In most cases, it's almost impossible to return something using const char * without constructing a string, which can be dangerous. More importantly, if the risk is ok, it's a pain ( for example, imagine returning an integer). Instead, we use a stream operator, which is more likely to succeed (still has issues though), but at least it's simple to use.
Having a different type than std::exception gives us a simple means to detect when the exception is something that we defined, vs something that came from the STL.

Definition at line 57 of file exception.h.

Constructor & Destructor Documentation

◆ general_exception()

bfn::general_exception::general_exception ( )

defaultnoexcept

Default Constructor

◆ ~general_exception()

bfn::general_exception::~general_exception ( )

overridedefault

Destructor

Member Function Documentation

◆ what()

const char* bfn::general_exception::what ( ) const

inlineoverridenoexcept

What

Returns a description of the exception. This function provides a simple means for unit testing to identify which exception was thrown, while still being able to support catching STL exceptions as well. This should not be used directly. Instead, use the stream operator.

Definition at line 76 of file exception.h.

◆ print()

virtual std::ostream& bfn::general_exception::print ( std::ostream & os ) const

inlinevirtual

Reimplemented in bfn::invalid_vmm_state_error, bfn::unknown_status_error, bfn::corrupt_vmm_error, bfn::ioctl_failed_error, bfn::driver_inaccessible_error, bfn::invalid_file_error, bfn::missing_argument_error, bfn::unknown_vmcall_data_type_error, bfn::unknown_vmcall_string_type_error, bfn::unknown_vmcall_type_error, and bfn::unknown_command_error.

Definition at line 81 of file exception.h.

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

/home/user/hypervisor/include/exception.h