CoreException Class Reference

#include <anope.h>

Inherited by ConfigException, ConvertException, DatabaseException, ModuleException, RegexException, and SocketException.

Collaboration diagram for CoreException:

Public Member Functions
	CoreException ()
	CoreException (const Anope::string &message)
	CoreException (const Anope::string &message, const Anope::string &src)
virtual	~CoreException () throw ()
virtual const Anope::string &	GetReason () const
virtual const Anope::string &	GetSource () const
Protected Attributes
Anope::string	err
Anope::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.

Definition at line 637 of file anope.h.

---

Constructor & Destructor Documentation

CoreException::CoreException

(

)

[inline]

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

Definition at line 649 of file anope.h.

CoreException::CoreException

(

const Anope::string &

message

)

[inline]

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

Definition at line 652 of file anope.h.

CoreException::CoreException	(	const Anope::string &	message,
		const Anope::string &	src
	)			[inline]

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

Definition at line 656 of file anope.h.

virtual CoreException::~CoreException

(

)

throw () [inline, virtual]

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

Exceptions:

Nothing!

Definition at line 661 of file anope.h.

---

Member Function Documentation

virtual const Anope::string& CoreException::GetReason

(

)

const [inline, virtual]

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

Definition at line 665 of file anope.h.

References err.

Referenced by CSAccess::CSAccess(), CommandOSAKill::DoAdd(), CSTop::DoTop(), CommandOSReload::Execute(), CommandOSConfig::Execute(), MyManager::HandlePacket(), Anope::HandleSignal(), Anope::Init(), XLine::InitRegex(), ModuleManager::LoadModule(), main(), Anope::Match(), ModuleProxyScan::ModuleProxyScan(), CommandOSSQLine::OnAdd(), CommandOSSNLine::OnAdd(), NSIdentifyLDAP::OnCheckAuthentication(), OnDatabaseReadMetadata(), LDAPOper::OnNickIdentify(), NSIdentifyLDAP::OnNickIdentify(), NSIdentifyLDAP::OnNickRegister(), ModuleSQLite::OnReload(), ModuleProxyScan::OnReload(), ModuleSQL::OnReload(), ModuleLDAP::OnReload(), HTTPD::OnReload(), ModuleDNS::OnReload(), OnIdentifyInterface::OnResult(), IdentifyInterface::OnResult(), ModuleProxyScan::OnUserConnect(), ModuleDNSBL::OnUserConnect(), OSDefcon::OSDefcon(), ClientSocket::Process(), ConnectionSocket::Process(), ListenSocket::ProcessRead(), ReadDatabase(), MyManager::SetIPPort(), and ReconnectTimer::Tick().

virtual const Anope::string& CoreException::GetSource

(

)

const [inline, virtual]

Definition at line 670 of file anope.h.

References source.

---

Field Documentation

Anope::string CoreException::err [protected]

Holds the error message to be displayed

Definition at line 642 of file anope.h.

Referenced by GetReason().

Anope::string CoreException::source [protected]

Source of the exception

Definition at line 645 of file anope.h.

Referenced by GetSource().

---

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

• include/anope.h