---

modules.h File Reference

#include "dynamic.h"
#include "base.h"
#include "ctables.h"
#include <string>
#include <deque>
#include <sstream>

Include dependency graph for modules.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Compounds
class	Admin
	Holds /ADMIN data This class contains the admin details of the local server. More...
class	ConfigReader
	Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. More...
class	FileReader
	Caches a text file into memory and can be used to retrieve lines from it. More...
class	Module
	Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...
class	ModuleFactory
	Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. More...
class	Server
	Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. More...
class	Version
	Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. More...
Defines
#define	DEBUG   10
#define	VERBOSE   20
#define	DEFAULT   30
#define	SPARSE   40
#define	NONE   50
#define	MT_CHANNEL   1
#define	MT_CLIENT   2
#define	MT_SERVER   3
#define	FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->
#define	FOREACH_RESULT(x)
Typedefs
typedef std::deque< std::string >	file_cache
	Low level definition of a FileReader classes file cache area.
typedef file_cache	string_list
typedef DLLFactory< ModuleFactory >	ircd_module
Functions
void	createcommand (char *cmd, handlerfunc f, char flags, int minparams)
void	server_mode (char **parameters, int pcnt, userrec *user)

---

Define Documentation

#define DEBUG   10

Definition at line 11 of file modules.h.

#define DEFAULT   30

Definition at line 13 of file modules.h.

#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->

Definition at line 38 of file modules.h.

#define FOREACH_RESULT (  x    )

Value: { MOD_RESULT = 0; \ for (int i = 0; i <= MODCOUNT; i++) { \ int res = modules[i]->x ; \ if (res) { \ MOD_RESULT = res; \ break; \ } \ } \ } Definition at line 46 of file modules.h.

#define MT_CHANNEL   1

Definition at line 17 of file modules.h.

#define MT_CLIENT   2

Definition at line 18 of file modules.h. Referenced by Server::AddExtendedMode().

#define MT_SERVER   3

Definition at line 19 of file modules.h. Referenced by Server::AddExtendedMode().

#define NONE   50

Definition at line 15 of file modules.h.

#define SPARSE   40

Definition at line 14 of file modules.h.

#define VERBOSE   20

Definition at line 12 of file modules.h.

---

Typedef Documentation

typedef std::deque<std::string> file_cache

Low level definition of a FileReader classes file cache area. Definition at line 30 of file modules.h. Referenced by FileReader::FileReader(), and FileReader::LoadFile().

typedef DLLFactory<ModuleFactory> ircd_module

Definition at line 625 of file modules.h.

typedef file_cache string_list

Definition at line 31 of file modules.h.

---

Function Documentation

void createcommand (  char *    cmd, handlerfunc    f, char    flags, int    minparams )

Referenced by Server::AddCommand().

void server_mode (  char **    parameters, int    pcnt, userrec *    user )

Referenced by Server::SendMode().

---