1 .TH "modules.h" 3 "12 May 2005" "InspIRCd" \" -*- nroff -*-
9 \fC#include 'dynamic.h'\fP
11 \fC#include 'base.h'\fP
13 \fC#include 'ctables.h'\fP
15 \fC#include <string>\fP
17 \fC#include <deque>\fP
19 \fC#include <sstream>\fP
26 .RI "class \fBAdmin\fP"
28 .RI "\fIHolds /ADMIN data This class contains the admin details of the local server. \fP"
30 .RI "class \fBConfigReader\fP"
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"
34 .RI "class \fBEvent\fP"
36 .RI "\fIThe Event class is a unicast message directed at all modules. \fP"
38 .RI "class \fBFileReader\fP"
40 .RI "\fICaches a text file into memory and can be used to retrieve lines from it. \fP"
42 .RI "class \fBModule\fP"
44 .RI "\fIBase class for all InspIRCd modules This class is the base class for InspIRCd modules. \fP"
46 .RI "class \fBModuleFactory\fP"
48 .RI "\fIInstantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new. \fP"
50 .RI "class \fBModuleMessage\fP"
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"
54 .RI "class \fBRequest\fP"
56 .RI "\fIThe Request class is a unicast message directed at a given module. \fP"
58 .RI "class \fBServer\fP"
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"
62 .RI "class \fBVersion\fP"
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"
70 .RI "#define \fBDEBUG\fP 10"
73 .RI "#define \fBVERBOSE\fP 20"
76 .RI "#define \fBDEFAULT\fP 30"
79 .RI "#define \fBSPARSE\fP 40"
82 .RI "#define \fBNONE\fP 50"
85 .RI "#define \fBMT_CHANNEL\fP 1"
88 .RI "#define \fBMT_CLIENT\fP 2"
91 .RI "#define \fBMT_SERVER\fP 3"
94 .RI "#define \fBACR_DEFAULT\fP 0"
97 .RI "#define \fBACR_DENY\fP 1"
100 .RI "#define \fBACR_ALLOW\fP 2"
103 .RI "#define \fBAC_KICK\fP 0"
106 .RI "#define \fBAC_DEOP\fP 1"
109 .RI "#define \fBAC_OP\fP 2"
112 .RI "#define \fBAC_VOICE\fP 3"
115 .RI "#define \fBAC_DEVOICE\fP 4"
118 .RI "#define \fBAC_HALFOP\fP 5"
121 .RI "#define \fBAC_DEHALFOP\fP 6"
124 .RI "#define \fBAC_INVITE\fP 7"
127 .RI "#define \fBAC_GENERAL_MODE\fP 8"
130 .RI "#define \fBVF_STATIC\fP 1"
133 .RI "#define \fBVF_VENDOR\fP 2"
136 .RI "#define \fBVF_SERVICEPROVIDER\fP 4"
139 .RI "#define \fBVF_COMMON\fP 8"
142 .RI "#define \fBFOREACH_MOD\fP for (int _i = 0; _i <= \fBMODCOUNT\fP; _i++) modules[_i]->"
145 .RI "#define \fBFOREACH_RESULT\fP(x)"
148 .RI "#define \fBFD_MAGIC_NUMBER\fP -42"
151 .RI "#define \fBCONF_NOT_A_NUMBER\fP 0x000010"
154 .RI "#define \fBCONF_NOT_UNSIGNED\fP 0x000080"
157 .RI "#define \fBCONF_VALUE_NOT_FOUND\fP 0x000100"
160 .RI "#define \fBCONF_FILE_NOT_FOUND\fP 0x000200"
167 .RI "typedef std::deque< std::string > \fBfile_cache\fP"
169 .RI "\fILow level definition of a \fBFileReader\fP classes file cache area. \fP"
171 .RI "typedef \fBfile_cache\fP \fBstring_list\fP"
174 .RI "typedef std::deque< \fBuserrec\fP * > \fBchanuserlist\fP"
176 .RI "\fIHolds a list of users in a channel. \fP"
178 .RI "typedef DLLFactory< \fBModuleFactory\fP > \fBircd_module\fP"
185 .RI "void \fBcreatecommand\fP (char *cmd, handlerfunc f, char flags, int minparams, char *source)"
188 .RI "void \fBserver_mode\fP (char **parameters, int pcnt, \fBuserrec\fP *user)"
191 .SH "Define Documentation"
193 .SS "#define AC_DEHALFOP 6"
195 Definition at line 47 of file modules.h.
196 .SS "#define AC_DEOP 1"
198 Definition at line 42 of file modules.h.
199 .SS "#define AC_DEVOICE 4"
201 Definition at line 45 of file modules.h.
202 .SS "#define AC_GENERAL_MODE 8"
204 Definition at line 49 of file modules.h.
205 .SS "#define AC_HALFOP 5"
207 Definition at line 46 of file modules.h.
208 .SS "#define AC_INVITE 7"
210 Definition at line 48 of file modules.h.
211 .SS "#define AC_KICK 0"
213 Definition at line 41 of file modules.h.
214 .SS "#define AC_OP 2"
216 Definition at line 43 of file modules.h.
217 .SS "#define AC_VOICE 3"
219 Definition at line 44 of file modules.h.
220 .SS "#define ACR_ALLOW 2"
222 Definition at line 39 of file modules.h.
223 .SS "#define ACR_DEFAULT 0"
225 Definition at line 37 of file modules.h.
227 Referenced by Module::OnAccessCheck().
228 .SS "#define ACR_DENY 1"
230 Definition at line 38 of file modules.h.
231 .SS "#define CONF_FILE_NOT_FOUND 0x000200"
233 Definition at line 1138 of file modules.h.
235 Referenced by ConfigReader::ConfigReader().
236 .SS "#define CONF_NOT_A_NUMBER 0x000010"
238 Definition at line 1135 of file modules.h.
240 Referenced by ConfigReader::ReadInteger().
241 .SS "#define CONF_NOT_UNSIGNED 0x000080"
243 Definition at line 1136 of file modules.h.
245 Referenced by ConfigReader::ReadInteger().
246 .SS "#define CONF_VALUE_NOT_FOUND 0x000100"
248 Definition at line 1137 of file modules.h.
250 Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
251 .SS "#define DEBUG 10"
253 Definition at line 23 of file modules.h.
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"
258 Definition at line 25 of file modules.h.
259 .SS "#define FD_MAGIC_NUMBER -42"
261 Definition at line 99 of file modules.h.
263 Referenced by Server::PseudoToUser(), and Server::UserToPseudo().
264 .SS "#define FOREACH_MOD for (int _i = 0; _i <= \fBMODCOUNT\fP; _i++) modules[_i]->"
266 Definition at line 79 of file modules.h.
268 Referenced by Event::Send().
269 .SS "#define FOREACH_RESULT(x)"
273 for (int _i = 0; _i <= MODCOUNT; _i++) { \
274 int res = modules[_i]->x ; \
283 Definition at line 87 of file modules.h.
284 .SS "#define MT_CHANNEL 1"
286 Definition at line 31 of file modules.h.
288 Referenced by Server::AddExtendedListMode(), and ModeMakeList().
289 .SS "#define MT_CLIENT 2"
291 Definition at line 32 of file modules.h.
293 Referenced by Server::AddExtendedMode().
294 .SS "#define MT_SERVER 3"
296 Definition at line 33 of file modules.h.
298 Referenced by Server::AddExtendedMode().
299 .SS "#define NONE 50"
301 Definition at line 27 of file modules.h.
302 .SS "#define SPARSE 40"
304 Definition at line 26 of file modules.h.
305 .SS "#define VERBOSE 20"
307 Definition at line 24 of file modules.h.
308 .SS "#define VF_COMMON 8"
310 Definition at line 56 of file modules.h.
311 .SS "#define VF_SERVICEPROVIDER 4"
313 Definition at line 55 of file modules.h.
314 .SS "#define VF_STATIC 1"
316 Definition at line 53 of file modules.h.
317 .SS "#define VF_VENDOR 2"
319 Definition at line 54 of file modules.h.
321 Referenced by Module::GetVersion().
322 .SH "Typedef Documentation"
324 .SS "typedef std::deque<\fBuserrec\fP*> \fBchanuserlist\fP"
326 Holds a list of users in a channel. Definition at line 72 of file modules.h.
328 Referenced by Server::GetUsers().
329 .SS "typedef std::deque<std::string> \fBfile_cache\fP"
331 Low level definition of a \fBFileReader\fP classes file cache area. Definition at line 67 of file modules.h.
333 Referenced by FileReader::FileReader(), and FileReader::LoadFile().
334 .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP"
336 Definition at line 1304 of file modules.h.
337 .SS "typedef \fBfile_cache\fP \fBstring_list\fP"
339 Definition at line 68 of file modules.h.
341 Referenced by Module::OnChannelSync(), and Module::OnUserSync().
342 .SH "Function Documentation"
344 .SS "void createcommand (char * cmd, handlerfunc f, char flags, int minparams, char * source)"
346 Referenced by Server::AddCommand().
347 .SS "void server_mode (char ** parameters, int pcnt, \fBuserrec\fP * user)"
349 Referenced by Server::SendMode().
352 Generated automatically by Doxygen for InspIRCd from the source code.