]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/classConnectClass.html
Documentation update
[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 Inherits <a class="el" href="classclassbase.html">classbase</a>.
14 <p>
15 <a href="classConnectClass-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16 <tr><td></td></tr>
17 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18 <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>
19
20 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
21 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o0">type</a></td></tr>
22
23 <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>
24 <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>
25
26 <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>
27 <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>
28
29 <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>
30 <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>
31
32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host mask for this line. </em> <a href="#o3"></a><em><br><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o4">pass</a> [MAXBUF]</td></tr>
34
35 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(Optional) Password for this line </em> <a href="#o4"></a><em><br><br></td></tr>
36 </table>
37 <hr><a name="_details"></a><h2>Detailed Description</h2>
38 Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file. 
39 <p>
40
41 <p>
42 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>
43 <a name="a0" doxytag="ConnectClass::ConnectClass"></a><p>
44 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
45   <tr>
46     <td class="mdRow">
47       <table cellpadding="0" cellspacing="0" border="0">
48         <tr>
49           <td class="md" nowrap valign="top"> ConnectClass::ConnectClass </td>
50           <td class="md" valign="top">(&nbsp;</td>
51           <td class="mdname1" valign="top" nowrap>          </td>
52           <td class="md" valign="top">&nbsp;)&nbsp;</td>
53           <td class="md" nowrap><code> [inline]</code></td>
54         </tr>
55
56       </table>
57     </td>
58   </tr>
59 </table>
60 <table cellspacing=5 cellpadding=0 border=0>
61   <tr>
62     <td>
63       &nbsp;
64     </td>
65     <td>
66
67 <p>
68
69 <p>
70 Definition at line <a class="el" href="users_8h-source.html#l00064">64</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
71 <p>
72 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#l00062">pass</a>, and <a class="el" href="users_8h-source.html#l00053">registration_timeout</a>.
73 <p>
74 <div class="fragment"><pre>00065         {
75 00066                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
76 00067                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
77 00068                 strlcpy(host,<span class="stringliteral">""</span>,MAXBUF);
78 00069                 strlcpy(pass,<span class="stringliteral">""</span>,MAXBUF);
79 00070         }
80 </pre></div>    </td>
81   </tr>
82 </table>
83 <hr><h2>Member Data Documentation</h2>
84 <a name="o2" doxytag="ConnectClass::flood"></a><p>
85 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
86   <tr>
87     <td class="mdRow">
88       <table cellpadding="0" cellspacing="0" border="0">
89         <tr>
90           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o2">ConnectClass::flood</a>
91       </table>
92     </td>
93   </tr>
94 </table>
95 <table cellspacing=5 cellpadding=0 border=0>
96   <tr>
97     <td>
98       &nbsp;
99     </td>
100     <td>
101
102 <p>
103 Number of lines in buffer before excess flood is triggered. 
104 <p>
105
106 <p>
107 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>.
108 <p>
109 Referenced by <a class="el" href="users_8h-source.html#l00064">ConnectClass()</a>.    </td>
110   </tr>
111 </table>
112 <a name="o3" doxytag="ConnectClass::host"></a><p>
113 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
114   <tr>
115     <td class="mdRow">
116       <table cellpadding="0" cellspacing="0" border="0">
117         <tr>
118           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o3">ConnectClass::host</a>[MAXBUF]
119       </table>
120     </td>
121   </tr>
122 </table>
123 <table cellspacing=5 cellpadding=0 border=0>
124   <tr>
125     <td>
126       &nbsp;
127     </td>
128     <td>
129
130 <p>
131 Host mask for this line. 
132 <p>
133
134 <p>
135 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>.
136 <p>
137 Referenced by <a class="el" href="users_8h-source.html#l00064">ConnectClass()</a>.    </td>
138   </tr>
139 </table>
140 <a name="o4" doxytag="ConnectClass::pass"></a><p>
141 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
142   <tr>
143     <td class="mdRow">
144       <table cellpadding="0" cellspacing="0" border="0">
145         <tr>
146           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o4">ConnectClass::pass</a>[MAXBUF]
147       </table>
148     </td>
149   </tr>
150 </table>
151 <table cellspacing=5 cellpadding=0 border=0>
152   <tr>
153     <td>
154       &nbsp;
155     </td>
156     <td>
157
158 <p>
159 (Optional) Password for this line 
160 <p>
161
162 <p>
163 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>.
164 <p>
165 Referenced by <a class="el" href="users_8h-source.html#l00064">ConnectClass()</a>.    </td>
166   </tr>
167 </table>
168 <a name="o1" doxytag="ConnectClass::registration_timeout"></a><p>
169 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
170   <tr>
171     <td class="mdRow">
172       <table cellpadding="0" cellspacing="0" border="0">
173         <tr>
174           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o1">ConnectClass::registration_timeout</a>
175       </table>
176     </td>
177   </tr>
178 </table>
179 <table cellspacing=5 cellpadding=0 border=0>
180   <tr>
181     <td>
182       &nbsp;
183     </td>
184     <td>
185
186 <p>
187 Max time to register the connection in seconds. 
188 <p>
189
190 <p>
191 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>.
192 <p>
193 Referenced by <a class="el" href="users_8h-source.html#l00064">ConnectClass()</a>.    </td>
194   </tr>
195 </table>
196 <a name="o0" doxytag="ConnectClass::type"></a><p>
197 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
198   <tr>
199     <td class="mdRow">
200       <table cellpadding="0" cellspacing="0" border="0">
201         <tr>
202           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o0">ConnectClass::type</a>
203       </table>
204     </td>
205   </tr>
206 </table>
207 <table cellspacing=5 cellpadding=0 border=0>
208   <tr>
209     <td>
210       &nbsp;
211     </td>
212     <td>
213
214 <p>
215 Type of line, either CC_ALLOW or CC_DENY. 
216 <p>
217
218 <p>
219 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>
220   </tr>
221 </table>
222 <hr>The documentation for this class was generated from the following file:<ul>
223 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
224 <hr size="1"><address style="align: right;"><small>Generated on Fri Mar 25 03:49:31 2005 for InspIRCd by
225 <a href="http://www.doxygen.org/index.html">
226 <img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
227 </a>1.3.3 </small></address>
228 </body>
229 </html>