#include <deque>
#include <sstream>
#include <typeinfo>
+#include "timer.h"
class Server;
class ServerConfig;
{ \
modules[_i]->x ; \
} \
- catch (ModuleException modexcept) \
+ catch (ModuleException& modexcept) \
{ \
log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
} \
break; \
} \
} \
- catch (ModuleException modexcept) \
+ catch (ModuleException& modexcept) \
{ \
log(DEBUG,"Module exception cought: %s",modexcept.GetReason()); \
} \
};
+/** 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.
+ */
class ModuleException
{
+ private:
+ /** Holds the error message to be displayed
+ */
+ std::string err;
public:
- ModuleException() {};
+ /** Default constructor, just uses the error mesage 'Module threw an exception'.
+ */
+ ModuleException() : err("Module threw an exception") {}
+ /** This constructor can be used to specify an error message before throwing.
+ */
+ ModuleException(std::string message) : err(message) {}
+ /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
+ * Actually no, it does nothing. Never mind.
+ */
virtual ~ModuleException() {};
+ /** Returns the reason for the exception.
+ * The module should probably put something informative here as the user will see this upon failure.
+ */
virtual char *GetReason()
{
- return "Module threw an exception";
+ return (char*)err.c_str();
}
};
/** Default constructor
* Creates a module class.
* @param Me An instance of the Server class which can be saved for future use
+ * \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
*/
Module(Server* Me);
*/
virtual int CountUsers(chanrec* c);
+ /** Adds an InspTimer which will trigger at a future time
+ */
+ virtual void AddTimer(InspTimer* T);
+
/** Attempts to look up a nick and return a pointer to it.
* This function will return NULL if the nick does not exist.
*/
* in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
* functiom will silently ignore it. The final parameter is the user executing the command handler,
* used for privilage checks, etc.
+ * @return True if the command exists
*/
- virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
+ virtual bool CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
/** This function returns true if the commandname exists, pcnt is equal to or greater than the number
* of paramters the command requires, the user specified is allowed to execute the command, AND
virtual void DelSocket(InspSocket* sock);
virtual void RehashServer();
+
+ virtual long GetChannelCount();
+
+ virtual chanrec* GetChannelIndex(long index);
};