2003-01-23 19:45:57 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=iso-8859-1" >
< title > modules.h File Reference< / title >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
2003-03-30 12:32:32 +00:00
<!-- Generated by Doxygen 1.3 - rc3 -->
2003-01-23 19:45:57 +00:00
< center >
< a class = "qindex" href = "main.html" > Main Page< / a > < a class = "qindex" href = "hierarchy.html" > Class Hierarchy< / a > < a class = "qindex" href = "classes.html" > Alphabetical List< / a > < a class = "qindex" href = "annotated.html" > Compound List< / a > < a class = "qindex" href = "files.html" > File List< / a > < a class = "qindex" href = "functions.html" > Compound Members< / a > < a class = "qindex" href = "globals.html" > File Members< / a > < / center >
< hr > < h1 > modules.h File Reference< / h1 > < code > #include "dynamic.h"< / code > < br >
2003-01-26 23:52:48 +00:00
< code > #include "< a class = "el" href = "base_8h-source.html" > base.h< / a > "< / code > < br >
2003-01-23 19:45:57 +00:00
< code > #include < string> < / code > < br >
< code > #include < deque> < / code > < br >
2003-03-30 12:32:32 +00:00
< p >
Include dependency graph for modules.h:< p > < center > < img src = "modules_8h__incl.gif" border = "0" usemap = "#modules.h_map" alt = "Include dependency graph" > < / center >
< map name = "modules.h_map" >
< area href = "base_8h.html" shape = "rect" coords = "100,85,148,106" alt = "" >
< / map >
< p >
This graph shows which files directly or indirectly include this file:< p > < center > < img src = "modules_8h__dep__incl.gif" border = "0" usemap = "#modules.hdep_map" alt = "Included by dependency graph" > < / center >
< map name = "modules.hdep_map" >
< area href = "modules_8cpp.html" shape = "rect" coords = "7,16,89,37" alt = "" >
< / map >
2003-01-23 19:45:57 +00:00
< p >
< a href = "modules_8h-source.html" > Go to the source code of this file.< / a > < table border = 0 cellpadding = 0 cellspacing = 0 >
< tr > < td > < / td > < / tr >
< tr > < td colspan = 2 > < br > < h2 > Compounds< / h2 > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classAdmin.html" > Admin< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Holds /ADMIN data This class contains the admin details of the local server.< / em > < a href = "classAdmin.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classConfigReader.html" > ConfigReader< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > 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.< / em > < a href = "classConfigReader.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classFileReader.html" > FileReader< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Caches a text file into memory and can be used to retrieve lines from it.< / em > < a href = "classFileReader.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classModule.html" > Module< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Base class for all InspIRCd modules This class is the base class for InspIRCd modules.< / em > < a href = "classModule.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classModuleFactory.html" > ModuleFactory< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Instantiates classes inherited from < a class = "el" href = "classModule.html" > Module< / a > This class creates a class inherited from type < a class = "el" href = "classModule.html" > Module< / a > , using new.< / em > < a href = "classModuleFactory.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classServer.html" > Server< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > 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.< / em > < a href = "classServer.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > class < / td > < td valign = bottom > < a class = "el" href = "classVersion.html" > Version< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module.< / em > < a href = "classVersion.html#_details" > More...< / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td colspan = 2 > < br > < h2 > Defines< / h2 > < / td > < / tr >
2003-02-09 12:49:00 +00:00
< tr > < td nowrap align = right valign = top > #define < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a0" > DEBUG< / a > 10< / td > < / tr >
< tr > < td nowrap align = right valign = top > #define < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a1" > VERBOSE< / a > 20< / td > < / tr >
< tr > < td nowrap align = right valign = top > #define < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a2" > DEFAULT< / a > 30< / td > < / tr >
< tr > < td nowrap align = right valign = top > #define < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a3" > SPARSE< / a > 40< / td > < / tr >
< tr > < td nowrap align = right valign = top > #define < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a4" > NONE< / a > 50< / td > < / tr >
< tr > < td nowrap align = right valign = top > #define < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a5" > FOREACH_MOD< / a > for (int i = 0; i < = < a class = "el" href = "modules_8cpp.html#a0" > MODCOUNT< / a > ; i++) modules[i]-> < / td > < / tr >
2003-01-23 19:45:57 +00:00
< tr > < td colspan = 2 > < br > < h2 > Typedefs< / h2 > < / td > < / tr >
2003-02-09 12:49:00 +00:00
< tr > < td nowrap align = right valign = top > typedef deque< string > < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a6" > file_cache< / a > < / td > < / tr >
< tr > < td > < / td > < td > < font size = -1 > < em > Low level definition of a < a class = "el" href = "classFileReader.html" > FileReader< / a > classes file cache area.< / em > < a href = "#a6" > < / a > < em > < / em > < / font > < br > < br > < / td > < / tr >
< tr > < td nowrap align = right valign = top > typedef DLLFactory< < a class = "el" href = "classModuleFactory.html" > ModuleFactory< / a > > < / td > < td valign = bottom > < a class = "el" href = "modules_8h.html#a7" > ircd_module< / a > < / td > < / tr >
2003-01-23 19:45:57 +00:00
< / table >
< hr > < h2 > Define Documentation< / h2 >
2003-02-09 12:49:00 +00:00
< a name = "a0" doxytag = "modules.h::DEBUG" > < / a > < p >
2003-01-23 19:45:57 +00:00
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
2003-02-09 12:49:00 +00:00
< td class = "md" nowrap valign = "top" > #define DEBUG 10
2003-01-23 19:45:57 +00:00
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
< p >
2003-02-09 12:49:00 +00:00
Definition at line < a class = "el" href = "modules_8h-source.html#l00011" > 11< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
< / tr >
< / table >
< a name = "a2" doxytag = "modules.h::DEFAULT" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > #define DEFAULT 30
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
< p >
Definition at line < a class = "el" href = "modules_8h-source.html#l00013" > 13< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
< / tr >
< / table >
< a name = "a5" doxytag = "modules.h::FOREACH_MOD" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > #define FOREACH_MOD for (int i = 0; i < = < a class = "el" href = "modules_8cpp.html#a0" > MODCOUNT< / a > ; i++) modules[i]->
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
< p >
Definition at line < a class = "el" href = "modules_8h-source.html#l00031" > 31< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
< / tr >
< / table >
< a name = "a4" doxytag = "modules.h::NONE" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > #define NONE 50
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
< p >
Definition at line < a class = "el" href = "modules_8h-source.html#l00015" > 15< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
< / tr >
< / table >
< a name = "a3" doxytag = "modules.h::SPARSE" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > #define SPARSE 40
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
< p >
Definition at line < a class = "el" href = "modules_8h-source.html#l00014" > 14< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
< / tr >
< / table >
< a name = "a1" doxytag = "modules.h::VERBOSE" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > #define VERBOSE 20
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
< p >
Definition at line < a class = "el" href = "modules_8h-source.html#l00012" > 12< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
2003-01-23 19:45:57 +00:00
< / tr >
< / table >
< hr > < h2 > Typedef Documentation< / h2 >
2003-02-09 12:49:00 +00:00
< a name = "a6" doxytag = "modules.h::file_cache" > < / a > < p >
2003-01-23 19:45:57 +00:00
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > typedef deque< string> file_cache
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
Low level definition of a < a class = "el" href = "classFileReader.html" > FileReader< / a > classes file cache area.
< p >
< p >
2003-02-09 12:49:00 +00:00
Definition at line < a class = "el" href = "modules_8h-source.html#l00024" > 24< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > .
< p >
2003-03-30 12:32:32 +00:00
Referenced by < a class = "el" href = "modules_8cpp-source.html#l00186" > FileReader::FileReader()< / a > , and < a class = "el" href = "modules_8cpp-source.html#l00197" > FileReader::LoadFile()< / a > . < / td >
2003-02-09 12:49:00 +00:00
< / tr >
< / table >
< a name = "a7" doxytag = "modules.h::ircd_module" > < / a > < p >
< table width = "100%" cellpadding = "2" cellspacing = "0" border = "0" >
< tr >
< td class = "md" >
< table cellpadding = "0" cellspacing = "0" border = "0" >
< tr >
< td class = "md" nowrap valign = "top" > typedef DLLFactory< < a class = "el" href = "classModuleFactory.html" > ModuleFactory< / a > > ircd_module
< / table >
< / td >
< / tr >
< / table >
< table cellspacing = 5 cellpadding = 0 border = 0 >
< tr >
< td >
< / td >
< td >
< p >
2003-01-23 19:45:57 +00:00
< p >
2003-03-30 18:38:07 +00:00
Definition at line < a class = "el" href = "modules_8h-source.html#l00355" > 355< / a > of file < a class = "el" href = "modules_8h-source.html" > modules.h< / a > . < / td >
2003-01-23 19:45:57 +00:00
< / tr >
< / table >
2003-03-30 18:38:07 +00:00
< hr > < address style = "align: right;" > < small > Generated on Sun Mar 30 19:35:14 2003 for InspIRCd by
2003-01-23 19:45:57 +00:00
< a href = "http://www.doxygen.org/index.html" >
< img src = "doxygen.png" alt = "doxygen" align = "middle" border = 0
2003-03-30 12:32:32 +00:00
width=110 height=53>< / a > 1.3-rc3 < / small > < / address >
2003-01-23 19:45:57 +00:00
< / body >
< / html >
