docs/man/man3/ConnectClass.3

   1 .TH "ConnectClass" 3 "13 May 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 "char \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 .ti -1c
  50 .RI "int \fBthreshold\fP"
  51 .br
  52 .RI "\fIThreshold value for flood disconnect. \fP"
  53 .ti -1c
  54 .RI "long \fBsendqmax\fP"
  55 .br
  56 .RI "\fIMaximum size of sendq for users in this class (bytes). \fP"
  57 .ti -1c
  58 .RI "long \fBrecvqmax\fP"
  59 .br
  60 .RI "\fIMaximum size of recvq for users in this class (bytes). \fP"
  61 .in -1c
  62 .SH "Detailed Description"
  63 .PP
  64 Holds information relevent to <connect allow> and <connect deny> tags in the config file. Definition at line 45 of file users.h.
  65 .SH "Constructor & Destructor Documentation"
  66 .PP
  67 .SS "ConnectClass::ConnectClass ()\fC [inline]\fP"
  68 .PP
  69 Definition at line 79 of file users.h.
  70 .PP
  71 References flood, host, pass, pingtime, recvqmax, registration_timeout, sendqmax, and threshold.
  72 .PP
  73 .nf
  74 80         {
  75 81                 registration_timeout = 0;
  76 82                 flood = 0;
  77 83                 pingtime = 0;
  78 84                 threshold = 0;
  79 85                 sendqmax = 0;
  80 86                 recvqmax = 0;
  81 87                 strlcpy(host,'',MAXBUF);
  82 88                 strlcpy(pass,'',MAXBUF);
  83 89         }
  84 .fi
  85 .SH "Member Data Documentation"
  86 .PP
  87 .SS "int \fBConnectClass::flood\fP"
  88 .PP
  89 Number of lines in buffer before excess flood is triggered. Definition at line 56 of file users.h.
  90 .PP
  91 Referenced by ConnectClass().
  92 .SS "char \fBConnectClass::host\fP[MAXBUF]"
  93 .PP
  94 Host mask for this line. Definition at line 59 of file users.h.
  95 .PP
  96 Referenced by ConnectClass().
  97 .SS "char \fBConnectClass::pass\fP[MAXBUF]"
  98 .PP
  99 (Optional) Password for this line Definition at line 65 of file users.h.
 100 .PP
 101 Referenced by ConnectClass().
 102 .SS "int \fBConnectClass::pingtime\fP"
 103 .PP
 104 Number of seconds between pings for this line. Definition at line 62 of file users.h.
 105 .PP
 106 Referenced by ConnectClass().
 107 .SS "long \fBConnectClass::recvqmax\fP"
 108 .PP
 109 Maximum size of recvq for users in this class (bytes). Definition at line 77 of file users.h.
 110 .PP
 111 Referenced by ConnectClass().
 112 .SS "int \fBConnectClass::registration_timeout\fP"
 113 .PP
 114 Max time to register the connection in seconds. Definition at line 53 of file users.h.
 115 .PP
 116 Referenced by ConnectClass().
 117 .SS "long \fBConnectClass::sendqmax\fP"
 118 .PP
 119 Maximum size of sendq for users in this class (bytes). Definition at line 73 of file users.h.
 120 .PP
 121 Referenced by ConnectClass().
 122 .SS "int \fBConnectClass::threshold\fP"
 123 .PP
 124 Threshold value for flood disconnect. Definition at line 69 of file users.h.
 125 .PP
 126 Referenced by ConnectClass().
 127 .SS "char \fBConnectClass::type\fP"
 128 .PP
 129 Type of line, either CC_ALLOW or CC_DENY. Definition at line 50 of file users.h.
 130
 131 .SH "Author"
 132 .PP
 133 Generated automatically by Doxygen for InspIRCd from the source code.