InspIRCd  2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations
Public Member Functions | Public Attributes | List of all members
CoreException Class Reference

#include <base.h>

Inheritance diagram for CoreException:
ModuleException

Public Member Functions

 CoreException ()
 
 CoreException (const std::string &message)
 
 CoreException (const std::string &message, const std::string &src)
 
virtual ~CoreException () throw ()
 
virtual const char * GetReason ()
 
virtual const char * GetSource ()
 

Public Attributes

const std::string err
 
const std::string source
 

Detailed Description

This class can be used on its own to represent an exception, or derived to represent a module-specific exception. When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or a class derived from ModuleException. If a module throws an exception during its constructor, the module will not be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.

Constructor & Destructor Documentation

CoreException::CoreException ( )
inline

Default constructor, just uses the error mesage 'Core threw an exception'.

CoreException::CoreException ( const std::string &  message)
inline

This constructor can be used to specify an error message before throwing.

CoreException::CoreException ( const std::string &  message,
const std::string &  src 
)
inline

This constructor can be used to specify an error message before throwing, and to specify the source of the exception.

virtual CoreException::~CoreException ( )
throw (
)
inlinevirtual

This destructor solves world hunger, cancels the world debt, and causes the world to end. Actually no, it does nothing. Never mind.

Exceptions
Nothing!

Member Function Documentation

virtual const char* CoreException::GetReason ( )
inlinevirtual

Returns the reason for the exception. The module should probably put something informative here as the user will see this upon failure.

Member Data Documentation

const std::string CoreException::err

Holds the error message to be displayed

const std::string CoreException::source

Source of the exception


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