docs/man/modules.h.3

   1 .TH "modules.h" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 modules.h \-
   6 .SH SYNOPSIS
   7 .br
   8 .PP
   9 \fC#include 'dynamic.h'\fP
  10 .br
  11 \fC#include 'base.h'\fP
  12 .br
  13 \fC#include 'ctables.h'\fP
  14 .br
  15 \fC#include <string>\fP
  16 .br
  17 \fC#include <deque>\fP
  18 .br
  19 \fC#include <sstream>\fP
  20 .br
  21
  22 .SS "Compounds"
  23
  24 .in +1c
  25 .ti -1c
  26 .RI "class \fBAdmin\fP"
  27 .br
  28 .RI "\fIHolds /ADMIN data This class contains the admin details of the local server.\fP"
  29 .ti -1c
  30 .RI "class \fBConfigReader\fP"
  31 .br
  32 .RI "\fIAllows 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.\fP"
  33 .ti -1c
  34 .RI "class \fBFileReader\fP"
  35 .br
  36 .RI "\fICaches a text file into memory and can be used to retrieve lines from it.\fP"
  37 .ti -1c
  38 .RI "class \fBModule\fP"
  39 .br
  40 .RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules.\fP"
  41 .ti -1c
  42 .RI "class \fBModuleFactory\fP"
  43 .br
  44 .RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.\fP"
  45 .ti -1c
  46 .RI "class \fBServer\fP"
  47 .br
  48 .RI "\fIAllows 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.\fP"
  49 .ti -1c
  50 .RI "class \fBVersion\fP"
  51 .br
  52 .RI "\fIHolds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module.\fP"
  53 .in -1c
  54 .SS "Defines"
  55
  56 .in +1c
  57 .ti -1c
  58 .RI "#define \fBDEBUG\fP   10"
  59 .br
  60 .ti -1c
  61 .RI "#define \fBVERBOSE\fP   20"
  62 .br
  63 .ti -1c
  64 .RI "#define \fBDEFAULT\fP   30"
  65 .br
  66 .ti -1c
  67 .RI "#define \fBSPARSE\fP   40"
  68 .br
  69 .ti -1c
  70 .RI "#define \fBNONE\fP   50"
  71 .br
  72 .ti -1c
  73 .RI "#define \fBMT_CHANNEL\fP   1"
  74 .br
  75 .ti -1c
  76 .RI "#define \fBMT_CLIENT\fP   2"
  77 .br
  78 .ti -1c
  79 .RI "#define \fBMT_SERVER\fP   3"
  80 .br
  81 .ti -1c
  82 .RI "#define \fBFOREACH_MOD\fP   for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->"
  83 .br
  84 .ti -1c
  85 .RI "#define \fBFOREACH_RESULT\fP(x)"
  86 .br
  87 .in -1c
  88 .SS "Typedefs"
  89
  90 .in +1c
  91 .ti -1c
  92 .RI "typedef std::deque< std::string > \fBfile_cache\fP"
  93 .br
  94 .RI "\fILow level definition of a \fBFileReader\fP classes file cache area.\fP"
  95 .ti -1c
  96 .RI "typedef \fBfile_cache\fP \fBstring_list\fP"
  97 .br
  98 .ti -1c
  99 .RI "typedef DLLFactory< \fBModuleFactory\fP > \fBircd_module\fP"
 100 .br
 101 .in -1c
 102 .SS "Functions"
 103
 104 .in +1c
 105 .ti -1c
 106 .RI "void \fBcreatecommand\fP (char *cmd, handlerfunc f, char flags, int minparams)"
 107 .br
 108 .ti -1c
 109 .RI "void \fBserver_mode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
 110 .br
 111 .in -1c
 112 .SH "Define Documentation"
 113 .PP
 114 .SS "#define DEBUG   10"
 115 .PP
 116 Definition at line 11 of file modules.h.
 117 .SS "#define DEFAULT   30"
 118 .PP
 119 Definition at line 13 of file modules.h.
 120 .SS "#define FOREACH_MOD   for (int i = 0; i <= \fBMODCOUNT\fP; i++) modules[i]->"
 121 .PP
 122 Definition at line 38 of file modules.h.
 123 .SS "#define FOREACH_RESULT(x)"
 124 .PP
 125 \fBValue:\fP.nf
 126 { MOD_RESULT = 0; \
 127                         for (int i = 0; i <= MODCOUNT; i++) { \
 128                         int res = modules[i]->x ; \
 129                         if (res) { \
 130                                 MOD_RESULT = res; \
 131                                 break; \
 132                         } \
 133                 } \
 134    }
 135 .fi
 136 .PP
 137 Definition at line 46 of file modules.h.
 138 .SS "#define MT_CHANNEL   1"
 139 .PP
 140 Definition at line 17 of file modules.h.
 141 .SS "#define MT_CLIENT   2"
 142 .PP
 143 Definition at line 18 of file modules.h.
 144 .PP
 145 Referenced by Server::AddExtendedMode().
 146 .SS "#define MT_SERVER   3"
 147 .PP
 148 Definition at line 19 of file modules.h.
 149 .PP
 150 Referenced by Server::AddExtendedMode().
 151 .SS "#define NONE   50"
 152 .PP
 153 Definition at line 15 of file modules.h.
 154 .SS "#define SPARSE   40"
 155 .PP
 156 Definition at line 14 of file modules.h.
 157 .SS "#define VERBOSE   20"
 158 .PP
 159 Definition at line 12 of file modules.h.
 160 .SH "Typedef Documentation"
 161 .PP
 162 .SS "typedef std::deque<std::string> file_cache"
 163 .PP
 164 Low level definition of a \fBFileReader\fP classes file cache area.Definition at line 30 of file modules.h.
 165 .PP
 166 Referenced by FileReader::FileReader(), and FileReader::LoadFile().
 167 .SS "typedef DLLFactory<\fBModuleFactory\fP> ircd_module"
 168 .PP
 169 Definition at line 646 of file modules.h.
 170 .SS "typedef \fBfile_cache\fP string_list"
 171 .PP
 172 Definition at line 31 of file modules.h.
 173 .SH "Function Documentation"
 174 .PP
 175 .SS "void createcommand (char * cmd, handlerfunc f, char flags, int minparams)"
 176 .PP
 177 Referenced by Server::AddCommand().
 178 .SS "void server_mode (char ** parameters, int pcnt, \fBuserrec\fP * user)"
 179 .PP
 180 Referenced by Server::SendMode().
 181 .SH "Author"
 182 .PP
 183 Generated automatically by Doxygen for InspIRCd from the source code.