]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/man/man3/XLine.3
Changed parameters of OnPacketTransmit and OnPacketReceive to be much more useful
[user/henk/code/inspircd.git] / docs / man / man3 / XLine.3
1 .TH "XLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 XLine \- XLine is the base class for ban lines such as G lines and K lines.  
6
7 .PP
8 .SH SYNOPSIS
9 .br
10 .PP
11 \fC#include <xline.h>\fP
12 .PP
13 Inherits \fBclassbase\fP.
14 .PP
15 Inherited by \fBELine\fP, \fBGLine\fP, \fBKLine\fP, \fBQLine\fP, and \fBZLine\fP.
16 .PP
17 .SS "Public Attributes"
18
19 .in +1c
20 .ti -1c
21 .RI "time_t \fBset_time\fP"
22 .br
23 .RI "\fIThe time the line was added. \fP"
24 .ti -1c
25 .RI "long \fBduration\fP"
26 .br
27 .RI "\fIThe duration of the ban, or 0 if permenant. \fP"
28 .ti -1c
29 .RI "char \fBsource\fP [MAXBUF]"
30 .br
31 .RI "\fISource of the ban. \fP"
32 .ti -1c
33 .RI "char \fBreason\fP [MAXBUF]"
34 .br
35 .RI "\fIReason for the ban. \fP"
36 .ti -1c
37 .RI "long \fBn_matches\fP"
38 .br
39 .RI "\fINumber of times the core matches the ban, for statistics. \fP"
40 .in -1c
41 .SH "Detailed Description"
42 .PP 
43 XLine is the base class for ban lines such as G lines and K lines. Definition at line 34 of file xline.h.
44 .SH "Member Data Documentation"
45 .PP 
46 .SS "long \fBXLine::duration\fP"
47 .PP
48 The duration of the ban, or 0 if permenant. Definition at line 44 of file xline.h.
49 .SS "long \fBXLine::n_matches\fP"
50 .PP
51 Number of times the core matches the ban, for statistics. Definition at line 56 of file xline.h.
52 .SS "char \fBXLine::reason\fP[MAXBUF]"
53 .PP
54 Reason for the ban. Definition at line 52 of file xline.h.
55 .SS "time_t \fBXLine::set_time\fP"
56 .PP
57 The time the line was added. Definition at line 40 of file xline.h.
58 .SS "char \fBXLine::source\fP[MAXBUF]"
59 .PP
60 Source of the ban. This can be a servername or an oper nicknameDefinition at line 48 of file xline.h.
61
62 .SH "Author"
63 .PP 
64 Generated automatically by Doxygen for InspIRCd from the source code.