]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/man/man3/ConnectClass.3
Changed parameters of OnPacketTransmit and OnPacketReceive to be much more useful
[user/henk/code/inspircd.git] / docs / man / man3 / ConnectClass.3
1 .TH "ConnectClass" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 ConnectClass \- Holds information relevent to <connect allow> and <connect deny> tags in the config file.  
6
7 .PP
8 .SH SYNOPSIS
9 .br
10 .PP
11 \fC#include <users.h>\fP
12 .PP
13 Inherits \fBclassbase\fP.
14 .PP
15 .SS "Public Member Functions"
16
17 .in +1c
18 .ti -1c
19 .RI "\fBConnectClass\fP ()"
20 .br
21 .in -1c
22 .SS "Public Attributes"
23
24 .in +1c
25 .ti -1c
26 .RI "int \fBtype\fP"
27 .br
28 .RI "\fIType of line, either CC_ALLOW or CC_DENY. \fP"
29 .ti -1c
30 .RI "int \fBregistration_timeout\fP"
31 .br
32 .RI "\fIMax time to register the connection in seconds. \fP"
33 .ti -1c
34 .RI "int \fBflood\fP"
35 .br
36 .RI "\fINumber of lines in buffer before excess flood is triggered. \fP"
37 .ti -1c
38 .RI "char \fBhost\fP [MAXBUF]"
39 .br
40 .RI "\fIHost mask for this line. \fP"
41 .ti -1c
42 .RI "int \fBpingtime\fP"
43 .br
44 .RI "\fINumber of seconds between pings for this line. \fP"
45 .ti -1c
46 .RI "char \fBpass\fP [MAXBUF]"
47 .br
48 .RI "\fI(Optional) Password for this line \fP"
49 .in -1c
50 .SH "Detailed Description"
51 .PP 
52 Holds information relevent to <connect allow> and <connect deny> tags in the config file. Definition at line 45 of file users.h.
53 .SH "Constructor & Destructor Documentation"
54 .PP 
55 .SS "ConnectClass::ConnectClass ()\fC [inline]\fP"
56 .PP
57 Definition at line 67 of file users.h.
58 .PP
59 References flood, host, pass, pingtime, and registration_timeout.
60 .PP
61 .nf
62 68         {
63 69                 registration_timeout = 0;
64 70                 flood = 0;
65 71                 pingtime = 0;
66 72                 strlcpy(host,'',MAXBUF);
67 73                 strlcpy(pass,'',MAXBUF);
68 74         }
69 .fi
70 .SH "Member Data Documentation"
71 .PP 
72 .SS "int \fBConnectClass::flood\fP"
73 .PP
74 Number of lines in buffer before excess flood is triggered. Definition at line 56 of file users.h.
75 .PP
76 Referenced by ConnectClass().
77 .SS "char \fBConnectClass::host\fP[MAXBUF]"
78 .PP
79 Host mask for this line. Definition at line 59 of file users.h.
80 .PP
81 Referenced by ConnectClass().
82 .SS "char \fBConnectClass::pass\fP[MAXBUF]"
83 .PP
84 (Optional) Password for this line Definition at line 65 of file users.h.
85 .PP
86 Referenced by ConnectClass().
87 .SS "int \fBConnectClass::pingtime\fP"
88 .PP
89 Number of seconds between pings for this line. Definition at line 62 of file users.h.
90 .PP
91 Referenced by ConnectClass().
92 .SS "int \fBConnectClass::registration_timeout\fP"
93 .PP
94 Max time to register the connection in seconds. Definition at line 53 of file users.h.
95 .PP
96 Referenced by ConnectClass().
97 .SS "int \fBConnectClass::type\fP"
98 .PP
99 Type of line, either CC_ALLOW or CC_DENY. Definition at line 50 of file users.h.
100
101 .SH "Author"
102 .PP 
103 Generated automatically by Doxygen for InspIRCd from the source code.