]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/man/man3/xline.h.3
bac860eff741cbdd2d3af8308b4e721e106d348f
[user/henk/code/inspircd.git] / docs / man / man3 / xline.h.3
1 .TH "xline.h" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 xline.h \- 
6 .SH SYNOPSIS
7 .br
8 .PP
9 \fC#include <typeinfo>\fP
10 .br
11 \fC#include <iostream>\fP
12 .br
13 \fC#include <string>\fP
14 .br
15 \fC#include <deque>\fP
16 .br
17 \fC#include <sstream>\fP
18 .br
19 \fC#include <vector>\fP
20 .br
21 \fC#include 'users.h'\fP
22 .br
23 \fC#include 'channels.h'\fP
24 .br
25
26 .SS "Classes"
27
28 .in +1c
29 .ti -1c
30 .RI "class \fBXLine\fP"
31 .br
32 .RI "\fIXLine is the base class for ban lines such as G lines and K lines. \fP"
33 .ti -1c
34 .RI "class \fBKLine\fP"
35 .br
36 .RI "\fIKLine class. \fP"
37 .ti -1c
38 .RI "class \fBGLine\fP"
39 .br
40 .RI "\fIGLine class. \fP"
41 .ti -1c
42 .RI "class \fBELine\fP"
43 .br
44 .ti -1c
45 .RI "class \fBZLine\fP"
46 .br
47 .RI "\fIZLine class. \fP"
48 .ti -1c
49 .RI "class \fBQLine\fP"
50 .br
51 .RI "\fIQLine class. \fP"
52 .in -1c
53 .SS "Functions"
54
55 .in +1c
56 .ti -1c
57 .RI "void \fBread_xline_defaults\fP ()"
58 .br
59 .ti -1c
60 .RI "void \fBadd_gline\fP (long duration, const char *source, const char *reason, const char *hostmask)"
61 .br
62 .ti -1c
63 .RI "void \fBadd_qline\fP (long duration, const char *source, const char *reason, const char *nickname)"
64 .br
65 .ti -1c
66 .RI "void \fBadd_zline\fP (long duration, const char *source, const char *reason, const char *ipaddr)"
67 .br
68 .ti -1c
69 .RI "void \fBadd_kline\fP (long duration, const char *source, const char *reason, const char *hostmask)"
70 .br
71 .ti -1c
72 .RI "void \fBadd_eline\fP (long duration, const char *source, const char *reason, const char *hostmask)"
73 .br
74 .ti -1c
75 .RI "bool \fBdel_gline\fP (const char *hostmask)"
76 .br
77 .ti -1c
78 .RI "bool \fBdel_qline\fP (const char *nickname)"
79 .br
80 .ti -1c
81 .RI "bool \fBdel_zline\fP (const char *ipaddr)"
82 .br
83 .ti -1c
84 .RI "bool \fBdel_kline\fP (const char *hostmask)"
85 .br
86 .ti -1c
87 .RI "bool \fBdel_eline\fP (const char *hostmask)"
88 .br
89 .ti -1c
90 .RI "char * \fBmatches_qline\fP (const char *nick)"
91 .br
92 .ti -1c
93 .RI "char * \fBmatches_gline\fP (const char *host)"
94 .br
95 .ti -1c
96 .RI "char * \fBmatches_zline\fP (const char *ipaddr)"
97 .br
98 .ti -1c
99 .RI "char * \fBmatches_kline\fP (const char *host)"
100 .br
101 .ti -1c
102 .RI "char * \fBmatches_exception\fP (const char *host)"
103 .br
104 .ti -1c
105 .RI "void \fBexpire_lines\fP ()"
106 .br
107 .ti -1c
108 .RI "void \fBapply_lines\fP (const int What)"
109 .br
110 .ti -1c
111 .RI "void \fBstats_k\fP (\fBuserrec\fP *user)"
112 .br
113 .ti -1c
114 .RI "void \fBstats_g\fP (\fBuserrec\fP *user)"
115 .br
116 .ti -1c
117 .RI "void \fBstats_q\fP (\fBuserrec\fP *user)"
118 .br
119 .ti -1c
120 .RI "void \fBstats_z\fP (\fBuserrec\fP *user)"
121 .br
122 .ti -1c
123 .RI "void \fBstats_e\fP (\fBuserrec\fP *user)"
124 .br
125 .ti -1c
126 .RI "void \fBgline_set_creation_time\fP (char *host, time_t create_time)"
127 .br
128 .ti -1c
129 .RI "void \fBqline_set_creation_time\fP (char *nick, time_t create_time)"
130 .br
131 .ti -1c
132 .RI "void \fBzline_set_creation_time\fP (char *ip, time_t create_time)"
133 .br
134 .ti -1c
135 .RI "void \fBeline_set_creation_time\fP (char *host, time_t create_time)"
136 .br
137 .ti -1c
138 .RI "bool \fBzline_make_global\fP (const char *ipaddr)"
139 .br
140 .ti -1c
141 .RI "bool \fBqline_make_global\fP (const char *nickname)"
142 .br
143 .in -1c
144 .SS "Variables"
145
146 .in +1c
147 .ti -1c
148 .RI "const int \fBAPPLY_GLINES\fP = 1"
149 .br
150 .ti -1c
151 .RI "const int \fBAPPLY_KLINES\fP = 2"
152 .br
153 .ti -1c
154 .RI "const int \fBAPPLY_QLINES\fP = 4"
155 .br
156 .ti -1c
157 .RI "const int \fBAPPLY_ZLINES\fP = 8"
158 .br
159 .ti -1c
160 .RI "const int \fBAPPLY_ALL\fP = \fBAPPLY_GLINES\fP | \fBAPPLY_KLINES\fP | \fBAPPLY_QLINES\fP | \fBAPPLY_ZLINES\fP"
161 .br
162 .in -1c
163 .SH "Function Documentation"
164 .PP 
165 .SS "void add_eline (long duration, const char * source, const char * reason, const char * hostmask)"
166 .PP
167 Referenced by Server::AddELine().
168 .SS "void add_gline (long duration, const char * source, const char * reason, const char * hostmask)"
169 .PP
170 Referenced by Server::AddGLine().
171 .SS "void add_kline (long duration, const char * source, const char * reason, const char * hostmask)"
172 .PP
173 Referenced by Server::AddKLine().
174 .SS "void add_qline (long duration, const char * source, const char * reason, const char * nickname)"
175 .PP
176 Referenced by Server::AddQLine().
177 .SS "void add_zline (long duration, const char * source, const char * reason, const char * ipaddr)"
178 .PP
179 Referenced by Server::AddZLine().
180 .SS "void apply_lines (const int What)"
181 .PP
182 .SS "bool del_eline (const char * hostmask)"
183 .PP
184 Referenced by Server::DelELine().
185 .SS "bool del_gline (const char * hostmask)"
186 .PP
187 Referenced by Server::DelGLine().
188 .SS "bool del_kline (const char * hostmask)"
189 .PP
190 Referenced by Server::DelKLine().
191 .SS "bool del_qline (const char * nickname)"
192 .PP
193 Referenced by Server::DelQLine().
194 .SS "bool del_zline (const char * ipaddr)"
195 .PP
196 Referenced by Server::DelZLine().
197 .SS "void eline_set_creation_time (char * host, time_t create_time)"
198 .PP
199 .SS "void expire_lines ()"
200 .PP
201 .SS "void gline_set_creation_time (char * host, time_t create_time)"
202 .PP
203 .SS "char* matches_exception (const char * host)"
204 .PP
205 .SS "char* matches_gline (const char * host)"
206 .PP
207 .SS "char* matches_kline (const char * host)"
208 .PP
209 .SS "char* matches_qline (const char * nick)"
210 .PP
211 .SS "char* matches_zline (const char * ipaddr)"
212 .PP
213 .SS "bool qline_make_global (const char * nickname)"
214 .PP
215 .SS "void qline_set_creation_time (char * nick, time_t create_time)"
216 .PP
217 .SS "void read_xline_defaults ()"
218 .PP
219 .SS "void stats_e (\fBuserrec\fP * user)"
220 .PP
221 .SS "void stats_g (\fBuserrec\fP * user)"
222 .PP
223 .SS "void stats_k (\fBuserrec\fP * user)"
224 .PP
225 .SS "void stats_q (\fBuserrec\fP * user)"
226 .PP
227 .SS "void stats_z (\fBuserrec\fP * user)"
228 .PP
229 .SS "bool zline_make_global (const char * ipaddr)"
230 .PP
231 .SS "void zline_set_creation_time (char * ip, time_t create_time)"
232 .PP
233 .SH "Variable Documentation"
234 .PP 
235 .SS "const int \fBAPPLY_ALL\fP = \fBAPPLY_GLINES\fP | \fBAPPLY_KLINES\fP | \fBAPPLY_QLINES\fP | \fBAPPLY_ZLINES\fP"
236 .PP
237 Definition at line 35 of file xline.h.
238 .SS "const int \fBAPPLY_GLINES\fP = 1"
239 .PP
240 Definition at line 31 of file xline.h.
241 .SS "const int \fBAPPLY_KLINES\fP = 2"
242 .PP
243 Definition at line 32 of file xline.h.
244 .SS "const int \fBAPPLY_QLINES\fP = 4"
245 .PP
246 Definition at line 33 of file xline.h.
247 .SS "const int \fBAPPLY_ZLINES\fP = 8"
248 .PP
249 Definition at line 34 of file xline.h.
250 .SH "Author"
251 .PP 
252 Generated automatically by Doxygen for InspIRCd from the source code.