VoiceMan
Public Member Functions | List of all members
VoicemanException Class Referenceabstract

The basic class for all VoiceMan exceptions. More...

Inheritance diagram for VoicemanException:
ConfigFileException ConfigFileValueTypeException ConfigurationException SystemException

Public Member Functions

virtual std::string getMessage () const =0
 Returns exception description. More...
 
virtual void makeLogReport (int level) const =0
 Makes report to logging system. More...
 
 VoicemanException ()
 The default constructor.
 
virtual ~VoicemanException ()
 The destructor.
 

Detailed Description

This is the ancestor of all exception classes used for error handling during VoiceMan server functioning. Catching errors with this root class allows get the code for processing all types of possible errors.

See also
SystemException ConfigFileException ConfigFileValueTypeException ConfigurationException

Member Function Documentation

virtual std::string VoicemanException::getMessage ( ) const
pure virtual

This method generates single line description of the error object. returned string can be printed to console or to log as error report.

Returns
The single-line error description

Implemented in ConfigFileException, SystemException, ConfigFileValueTypeException, and ConfigurationException.

virtual void VoicemanException::makeLogReport ( int  level) const
pure virtual

This function writes to log a report about error object. It may be not exactly the same value as produced by getMessage() method. The level of message must be specified, because the same error can have different levels in different situations. For example, configuration file error is critical error during server startup process due to to requirement have first configuration information, but be just a usual error in configuration reloading, because in this case server can successfully use its previous configuration data.

Parameters
levelThe level of error log report

Implemented in ConfigFileException, SystemException, ConfigFileValueTypeException, and ConfigurationException.