]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classConnectClass.html
Re-added the dot graphs again
[user/henk/code/inspircd.git] / docs / module-doc / classConnectClass.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>InspIRCd: ConnectClass class Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3.3 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
8 <h1>ConnectClass Class Reference</h1>Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.  
9 <a href="#_details">More...</a>
10 <p>
11 <code>#include &lt;<a class="el" href="users_8h-source.html">users.h</a>&gt;</code>
12 <p>
13 Inheritance diagram for ConnectClass:<p><center><img src="classConnectClass__inherit__graph.gif" border="0" usemap="#ConnectClass__inherit__map" alt="Inheritance graph"></center>
14 <map name="ConnectClass__inherit__map">
15 <area href="classclassbase.html" shape="rect" coords="20,7,100,34" alt="">
16 </map>
17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ConnectClass:<p><center><img src="classConnectClass__coll__graph.gif" border="0" usemap="#ConnectClass__coll__map" alt="Collaboration graph"></center>
18 <map name="ConnectClass__coll__map">
19 <area href="classclassbase.html" shape="rect" coords="8,98,88,125" alt="">
20 </map>
21 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classConnectClass-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22 <tr><td></td></tr>
23 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#a0">ConnectClass</a> ()</td></tr>
25
26 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
27 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o0">type</a></td></tr>
28
29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of line, either CC_ALLOW or CC_DENY. </em> <a href="#o0"></a><em><br><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o1">registration_timeout</a></td></tr>
31
32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max time to register the connection in seconds. </em> <a href="#o1"></a><em><br><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o2">flood</a></td></tr>
34
35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of lines in buffer before excess flood is triggered. </em> <a href="#o2"></a><em><br><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o3">host</a> [MAXBUF]</td></tr>
37
38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host mask for this line. </em> <a href="#o3"></a><em><br><br></td></tr>
39 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o4">pingtime</a></td></tr>
40
41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of seconds between pings for this line. </em> <a href="#o4"></a><em><br><br></td></tr>
42 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o5">pass</a> [MAXBUF]</td></tr>
43
44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(Optional) Password for this line </em> <a href="#o5"></a><em><br><br></td></tr>
45 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o6">threshold</a></td></tr>
46
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threshold value for flood disconnect. </em> <a href="#o6"></a><em><br><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o7">sendqmax</a></td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum size of sendq for users in this class (bytes). </em> <a href="#o7"></a><em><br><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o8">recvqmax</a></td></tr>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum size of recvq for users in this class (bytes). </em> <a href="#o8"></a><em><br><br></td></tr>
54 </table>
55 <hr><a name="_details"></a><h2>Detailed Description</h2>
56 Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file. 
57 <p>
58
59 <p>
60 Definition at line <a class="el" href="users_8h-source.html#l00045">45</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
61 <a name="a0" doxytag="ConnectClass::ConnectClass"></a><p>
62 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
63   <tr>
64     <td class="mdRow">
65       <table cellpadding="0" cellspacing="0" border="0">
66         <tr>
67           <td class="md" nowrap valign="top"> ConnectClass::ConnectClass </td>
68           <td class="md" valign="top">(&nbsp;</td>
69           <td class="mdname1" valign="top" nowrap>          </td>
70           <td class="md" valign="top">&nbsp;)&nbsp;</td>
71           <td class="md" nowrap><code> [inline]</code></td>
72         </tr>
73
74       </table>
75     </td>
76   </tr>
77 </table>
78 <table cellspacing=5 cellpadding=0 border=0>
79   <tr>
80     <td>
81       &nbsp;
82     </td>
83     <td>
84
85 <p>
86
87 <p>
88 Definition at line <a class="el" href="users_8h-source.html#l00079">79</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
89 <p>
90 References <a class="el" href="users_8h-source.html#l00056">flood</a>, <a class="el" href="users_8h-source.html#l00059">host</a>, <a class="el" href="users_8h-source.html#l00065">pass</a>, <a class="el" href="users_8h-source.html#l00062">pingtime</a>, <a class="el" href="users_8h-source.html#l00077">recvqmax</a>, <a class="el" href="users_8h-source.html#l00053">registration_timeout</a>, <a class="el" href="users_8h-source.html#l00073">sendqmax</a>, and <a class="el" href="users_8h-source.html#l00069">threshold</a>.
91 <p>
92 <div class="fragment"><pre>00080         {
93 00081                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
94 00082                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
95 00083                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
96 00084                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
97 00085                 <a class="code" href="classConnectClass.html#o7">sendqmax</a> = 0;
98 00086                 <a class="code" href="classConnectClass.html#o8">recvqmax</a> = 0;
99 00087                 strlcpy(host,<span class="stringliteral">""</span>,MAXBUF);
100 00088                 strlcpy(pass,<span class="stringliteral">""</span>,MAXBUF);
101 00089         }
102 </pre></div>    </td>
103   </tr>
104 </table>
105 <hr><h2>Member Data Documentation</h2>
106 <a name="o2" doxytag="ConnectClass::flood"></a><p>
107 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
108   <tr>
109     <td class="mdRow">
110       <table cellpadding="0" cellspacing="0" border="0">
111         <tr>
112           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o2">ConnectClass::flood</a>
113       </table>
114     </td>
115   </tr>
116 </table>
117 <table cellspacing=5 cellpadding=0 border=0>
118   <tr>
119     <td>
120       &nbsp;
121     </td>
122     <td>
123
124 <p>
125 Number of lines in buffer before excess flood is triggered. 
126 <p>
127
128 <p>
129 Definition at line <a class="el" href="users_8h-source.html#l00056">56</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
130 <p>
131 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
132   </tr>
133 </table>
134 <a name="o3" doxytag="ConnectClass::host"></a><p>
135 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
136   <tr>
137     <td class="mdRow">
138       <table cellpadding="0" cellspacing="0" border="0">
139         <tr>
140           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o3">ConnectClass::host</a>[MAXBUF]
141       </table>
142     </td>
143   </tr>
144 </table>
145 <table cellspacing=5 cellpadding=0 border=0>
146   <tr>
147     <td>
148       &nbsp;
149     </td>
150     <td>
151
152 <p>
153 Host mask for this line. 
154 <p>
155
156 <p>
157 Definition at line <a class="el" href="users_8h-source.html#l00059">59</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
158 <p>
159 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
160   </tr>
161 </table>
162 <a name="o5" doxytag="ConnectClass::pass"></a><p>
163 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
164   <tr>
165     <td class="mdRow">
166       <table cellpadding="0" cellspacing="0" border="0">
167         <tr>
168           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o5">ConnectClass::pass</a>[MAXBUF]
169       </table>
170     </td>
171   </tr>
172 </table>
173 <table cellspacing=5 cellpadding=0 border=0>
174   <tr>
175     <td>
176       &nbsp;
177     </td>
178     <td>
179
180 <p>
181 (Optional) Password for this line 
182 <p>
183
184 <p>
185 Definition at line <a class="el" href="users_8h-source.html#l00065">65</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
186 <p>
187 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
188   </tr>
189 </table>
190 <a name="o4" doxytag="ConnectClass::pingtime"></a><p>
191 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
192   <tr>
193     <td class="mdRow">
194       <table cellpadding="0" cellspacing="0" border="0">
195         <tr>
196           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o4">ConnectClass::pingtime</a>
197       </table>
198     </td>
199   </tr>
200 </table>
201 <table cellspacing=5 cellpadding=0 border=0>
202   <tr>
203     <td>
204       &nbsp;
205     </td>
206     <td>
207
208 <p>
209 Number of seconds between pings for this line. 
210 <p>
211
212 <p>
213 Definition at line <a class="el" href="users_8h-source.html#l00062">62</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
214 <p>
215 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
216   </tr>
217 </table>
218 <a name="o8" doxytag="ConnectClass::recvqmax"></a><p>
219 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
220   <tr>
221     <td class="mdRow">
222       <table cellpadding="0" cellspacing="0" border="0">
223         <tr>
224           <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o8">ConnectClass::recvqmax</a>
225       </table>
226     </td>
227   </tr>
228 </table>
229 <table cellspacing=5 cellpadding=0 border=0>
230   <tr>
231     <td>
232       &nbsp;
233     </td>
234     <td>
235
236 <p>
237 Maximum size of recvq for users in this class (bytes). 
238 <p>
239
240 <p>
241 Definition at line <a class="el" href="users_8h-source.html#l00077">77</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
242 <p>
243 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
244   </tr>
245 </table>
246 <a name="o1" doxytag="ConnectClass::registration_timeout"></a><p>
247 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
248   <tr>
249     <td class="mdRow">
250       <table cellpadding="0" cellspacing="0" border="0">
251         <tr>
252           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o1">ConnectClass::registration_timeout</a>
253       </table>
254     </td>
255   </tr>
256 </table>
257 <table cellspacing=5 cellpadding=0 border=0>
258   <tr>
259     <td>
260       &nbsp;
261     </td>
262     <td>
263
264 <p>
265 Max time to register the connection in seconds. 
266 <p>
267
268 <p>
269 Definition at line <a class="el" href="users_8h-source.html#l00053">53</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
270 <p>
271 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
272   </tr>
273 </table>
274 <a name="o7" doxytag="ConnectClass::sendqmax"></a><p>
275 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
276   <tr>
277     <td class="mdRow">
278       <table cellpadding="0" cellspacing="0" border="0">
279         <tr>
280           <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o7">ConnectClass::sendqmax</a>
281       </table>
282     </td>
283   </tr>
284 </table>
285 <table cellspacing=5 cellpadding=0 border=0>
286   <tr>
287     <td>
288       &nbsp;
289     </td>
290     <td>
291
292 <p>
293 Maximum size of sendq for users in this class (bytes). 
294 <p>
295
296 <p>
297 Definition at line <a class="el" href="users_8h-source.html#l00073">73</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
298 <p>
299 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
300   </tr>
301 </table>
302 <a name="o6" doxytag="ConnectClass::threshold"></a><p>
303 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
304   <tr>
305     <td class="mdRow">
306       <table cellpadding="0" cellspacing="0" border="0">
307         <tr>
308           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o6">ConnectClass::threshold</a>
309       </table>
310     </td>
311   </tr>
312 </table>
313 <table cellspacing=5 cellpadding=0 border=0>
314   <tr>
315     <td>
316       &nbsp;
317     </td>
318     <td>
319
320 <p>
321 Threshold value for flood disconnect. 
322 <p>
323
324 <p>
325 Definition at line <a class="el" href="users_8h-source.html#l00069">69</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
326 <p>
327 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
328   </tr>
329 </table>
330 <a name="o0" doxytag="ConnectClass::type"></a><p>
331 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
332   <tr>
333     <td class="mdRow">
334       <table cellpadding="0" cellspacing="0" border="0">
335         <tr>
336           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o0">ConnectClass::type</a>
337       </table>
338     </td>
339   </tr>
340 </table>
341 <table cellspacing=5 cellpadding=0 border=0>
342   <tr>
343     <td>
344       &nbsp;
345     </td>
346     <td>
347
348 <p>
349 Type of line, either CC_ALLOW or CC_DENY. 
350 <p>
351
352 <p>
353 Definition at line <a class="el" href="users_8h-source.html#l00050">50</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
354   </tr>
355 </table>
356 <hr>The documentation for this class was generated from the following file:<ul>
357 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
358 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:33 2005 for InspIRCd by
359 <a href="http://www.doxygen.org/index.html">
360 <img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
361 </a>1.3.3 </small></address>
362 </body>
363 </html>