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