docs/man/man3/modules.h.3

   1 .TH "modules.h" 3 "13 May 2005" "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 \fBEvent\fP"
  35 .br
  36 .RI "\fIThe Event class is a unicast message directed at all modules. \fP"
  37 .ti -1c
  38 .RI "class \fBFileReader\fP"
  39 .br
  40 .RI "\fICaches a text file into memory and can be used to retrieve lines from it. \fP"
  41 .ti -1c
  42 .RI "class \fBModule\fP"
  43 .br
  44 .RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules. \fP"
  45 .ti -1c
  46 .RI "class \fBModuleFactory\fP"
  47 .br
  48 .RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. \fP"
  49 .ti -1c
  50 .RI "class \fBModuleMessage\fP"
  51 .br
  52 .RI "\fIThe ModuleMessage class is the base class of \fBRequest\fP and \fBEvent\fP This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. \fP"
  53 .ti -1c
  54 .RI "class \fBRequest\fP"
  55 .br
  56 .RI "\fIThe Request class is a unicast message directed at a given module. \fP"
  57 .ti -1c
  58 .RI "class \fBServer\fP"
  59 .br
  60 .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"
  61 .ti -1c
  62 .RI "class \fBVersion\fP"
  63 .br
  64 .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"
  65 .in -1c
  66 .SS "Defines"
  67
  68 .in +1c
  69 .ti -1c
  70 .RI "#define \fBDEBUG\fP   10"
  71 .br
  72 .ti -1c
  73 .RI "#define \fBVERBOSE\fP   20"
  74 .br
  75 .ti -1c
  76 .RI "#define \fBDEFAULT\fP   30"
  77 .br
  78 .ti -1c
  79 .RI "#define \fBSPARSE\fP   40"
  80 .br
  81 .ti -1c
  82 .RI "#define \fBNONE\fP   50"
  83 .br
  84 .ti -1c
  85 .RI "#define \fBMT_CHANNEL\fP   1"
  86 .br
  87 .ti -1c
  88 .RI "#define \fBMT_CLIENT\fP   2"
  89 .br
  90 .ti -1c
  91 .RI "#define \fBMT_SERVER\fP   3"
  92 .br
  93 .ti -1c
  94 .RI "#define \fBACR_DEFAULT\fP   0"
  95 .br
  96 .ti -1c
  97 .RI "#define \fBACR_DENY\fP   1"
  98 .br
  99 .ti -1c
 100 .RI "#define \fBACR_ALLOW\fP   2"
 101 .br
 102 .ti -1c
 103 .RI "#define \fBAC_KICK\fP   0"
 104 .br
 105 .ti -1c
 106 .RI "#define \fBAC_DEOP\fP   1"
 107 .br
 108 .ti -1c
 109 .RI "#define \fBAC_OP\fP   2"
 110 .br
 111 .ti -1c
 112 .RI "#define \fBAC_VOICE\fP   3"
 113 .br
 114 .ti -1c
 115 .RI "#define \fBAC_DEVOICE\fP   4"
 116 .br
 117 .ti -1c
 118 .RI "#define \fBAC_HALFOP\fP   5"
 119 .br
 120 .ti -1c
 121 .RI "#define \fBAC_DEHALFOP\fP   6"
 122 .br
 123 .ti -1c
 124 .RI "#define \fBAC_INVITE\fP   7"
 125 .br
 126 .ti -1c
 127 .RI "#define \fBAC_GENERAL_MODE\fP   8"
 128 .br
 129 .ti -1c
 130 .RI "#define \fBVF_STATIC\fP   1"
 131 .br
 132 .ti -1c
 133 .RI "#define \fBVF_VENDOR\fP   2"
 134 .br
 135 .ti -1c
 136 .RI "#define \fBVF_SERVICEPROVIDER\fP   4"
 137 .br
 138 .ti -1c
 139 .RI "#define \fBVF_COMMON\fP   8"
 140 .br
 141 .ti -1c
 142 .RI "#define \fBFOREACH_MOD\fP   for (int _i = 0; _i <= \fBMODCOUNT\fP; _i++) modules[_i]->"
 143 .br
 144 .ti -1c
 145 .RI "#define \fBFOREACH_RESULT\fP(x)"
 146 .br
 147 .ti -1c
 148 .RI "#define \fBFD_MAGIC_NUMBER\fP   -42"
 149 .br
 150 .ti -1c
 151 .RI "#define \fBCONF_NOT_A_NUMBER\fP   0x000010"
 152 .br
 153 .ti -1c
 154 .RI "#define \fBCONF_NOT_UNSIGNED\fP   0x000080"
 155 .br
 156 .ti -1c
 157 .RI "#define \fBCONF_VALUE_NOT_FOUND\fP   0x000100"
 158 .br
 159 .ti -1c
 160 .RI "#define \fBCONF_FILE_NOT_FOUND\fP   0x000200"
 161 .br
 162 .in -1c
 163 .SS "Typedefs"
 164
 165 .in +1c
 166 .ti -1c
 167 .RI "typedef std::deque< std::string > \fBfile_cache\fP"
 168 .br
 169 .RI "\fILow level definition of a \fBFileReader\fP classes file cache area. \fP"
 170 .ti -1c
 171 .RI "typedef \fBfile_cache\fP \fBstring_list\fP"
 172 .br
 173 .ti -1c
 174 .RI "typedef std::deque< \fBuserrec\fP * > \fBchanuserlist\fP"
 175 .br
 176 .RI "\fIHolds a list of users in a channel. \fP"
 177 .ti -1c
 178 .RI "typedef DLLFactory< \fBModuleFactory\fP > \fBircd_module\fP"
 179 .br
 180 .in -1c
 181 .SS "Functions"
 182
 183 .in +1c
 184 .ti -1c
 185 .RI "void \fBcreatecommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)"
 186 .br
 187 .ti -1c
 188 .RI "void \fBserver_mode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
 189 .br
 190 .in -1c
 191 .SH "Define Documentation"
 192 .PP
 193 .SS "#define AC_DEHALFOP   6"
 194 .PP
 195 Definition at line 47 of file modules.h.
 196 .SS "#define AC_DEOP   1"
 197 .PP
 198 Definition at line 42 of file modules.h.
 199 .SS "#define AC_DEVOICE   4"
 200 .PP
 201 Definition at line 45 of file modules.h.
 202 .SS "#define AC_GENERAL_MODE   8"
 203 .PP
 204 Definition at line 49 of file modules.h.
 205 .SS "#define AC_HALFOP   5"
 206 .PP
 207 Definition at line 46 of file modules.h.
 208 .SS "#define AC_INVITE   7"
 209 .PP
 210 Definition at line 48 of file modules.h.
 211 .SS "#define AC_KICK   0"
 212 .PP
 213 Definition at line 41 of file modules.h.
 214 .SS "#define AC_OP   2"
 215 .PP
 216 Definition at line 43 of file modules.h.
 217 .SS "#define AC_VOICE   3"
 218 .PP
 219 Definition at line 44 of file modules.h.
 220 .SS "#define ACR_ALLOW   2"
 221 .PP
 222 Definition at line 39 of file modules.h.
 223 .SS "#define ACR_DEFAULT   0"
 224 .PP
 225 Definition at line 37 of file modules.h.
 226 .PP
 227 Referenced by Module::OnAccessCheck().
 228 .SS "#define ACR_DENY   1"
 229 .PP
 230 Definition at line 38 of file modules.h.
 231 .SS "#define CONF_FILE_NOT_FOUND   0x000200"
 232 .PP
 233 Definition at line 1138 of file modules.h.
 234 .PP
 235 Referenced by ConfigReader::ConfigReader().
 236 .SS "#define CONF_NOT_A_NUMBER   0x000010"
 237 .PP
 238 Definition at line 1135 of file modules.h.
 239 .PP
 240 Referenced by ConfigReader::ReadInteger().
 241 .SS "#define CONF_NOT_UNSIGNED   0x000080"
 242 .PP
 243 Definition at line 1136 of file modules.h.
 244 .PP
 245 Referenced by ConfigReader::ReadInteger().
 246 .SS "#define CONF_VALUE_NOT_FOUND   0x000100"
 247 .PP
 248 Definition at line 1137 of file modules.h.
 249 .PP
 250 Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
 251 .SS "#define DEBUG   10"
 252 .PP
 253 Definition at line 23 of file modules.h.
 254 .PP
 255 Referenced by Server::AddExtendedMode(), chanrec::AddUser(), chanrec::DelUser(), userrec::HasPermission(), chanrec::IsCustomModeSet(), userrec::RemoveInvite(), chanrec::SetCustomMode(), chanrec::SetCustomModeParam(), userrec::SetWriteError(), and Server::UserToPseudo().
 256 .SS "#define DEFAULT   30"
 257 .PP
 258 Definition at line 25 of file modules.h.
 259 .SS "#define FD_MAGIC_NUMBER   -42"
 260 .PP
 261 Definition at line 99 of file modules.h.
 262 .PP
 263 Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
 264 .SS "#define FOREACH_MOD   for (int _i = 0; _i <= \fBMODCOUNT\fP; _i++) modules[_i]->"
 265 .PP
 266 Definition at line 79 of file modules.h.
 267 .PP
 268 Referenced by Event::Send().
 269 .SS "#define FOREACH_RESULT(x)"
 270 .PP
 271 \fBValue:\fP.nf
 272 { MOD_RESULT = 0; \
 273                         for (int _i = 0; _i <= MODCOUNT; _i++) { \
 274                         int res = modules[_i]->x ; \
 275                         if (res != 0) { \
 276                                 MOD_RESULT = res; \
 277                                 break; \
 278                         } \
 279                 } \
 280         }
 281 .fi
 282 .PP
 283 Definition at line 87 of file modules.h.
 284 .SS "#define MT_CHANNEL   1"
 285 .PP
 286 Definition at line 31 of file modules.h.
 287 .PP
 288 Referenced by Server::AddExtendedListMode(), and ModeMakeList().
 289 .SS "#define MT_CLIENT   2"
 290 .PP
 291 Definition at line 32 of file modules.h.
 292 .PP
 293 Referenced by Server::AddExtendedMode().
 294 .SS "#define MT_SERVER   3"
 295 .PP
 296 Definition at line 33 of file modules.h.
 297 .PP
 298 Referenced by Server::AddExtendedMode().
 299 .SS "#define NONE   50"
 300 .PP
 301 Definition at line 27 of file modules.h.
 302 .SS "#define SPARSE   40"
 303 .PP
 304 Definition at line 26 of file modules.h.
 305 .SS "#define VERBOSE   20"
 306 .PP
 307 Definition at line 24 of file modules.h.
 308 .SS "#define VF_COMMON   8"
 309 .PP
 310 Definition at line 56 of file modules.h.
 311 .SS "#define VF_SERVICEPROVIDER   4"
 312 .PP
 313 Definition at line 55 of file modules.h.
 314 .SS "#define VF_STATIC   1"
 315 .PP
 316 Definition at line 53 of file modules.h.
 317 .SS "#define VF_VENDOR   2"
 318 .PP
 319 Definition at line 54 of file modules.h.
 320 .PP
 321 Referenced by Module::GetVersion().
 322 .SH "Typedef Documentation"
 323 .PP
 324 .SS "typedef std::deque<\fBuserrec\fP*> \fBchanuserlist\fP"
 325 .PP
 326 Holds a list of users in a channel. Definition at line 72 of file modules.h.
 327 .PP
 328 Referenced by Server::GetUsers().
 329 .SS "typedef std::deque<std::string> \fBfile_cache\fP"
 330 .PP
 331 Low level definition of a \fBFileReader\fP classes file cache area. Definition at line 67 of file modules.h.
 332 .PP
 333 Referenced by FileReader::FileReader(), and FileReader::LoadFile().
 334 .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP"
 335 .PP
 336 Definition at line 1304 of file modules.h.
 337 .SS "typedef \fBfile_cache\fP \fBstring_list\fP"
 338 .PP
 339 Definition at line 68 of file modules.h.
 340 .PP
 341 Referenced by Module::OnChannelSync(), and Module::OnUserSync().
 342 .SH "Function Documentation"
 343 .PP
 344 .SS "void createcommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)"
 345 .PP
 346 Referenced by Server::AddCommand().
 347 .SS "void server_mode (char ** parameters, int pcnt, \fBuserrec\fP * user)"
 348 .PP
 349 Referenced by Server::SendMode().
 350 .SH "Author"
 351 .PP
 352 Generated automatically by Doxygen for InspIRCd from the source code.