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>char&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>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o4">pingtime</a></td></tr>
  34
  35 <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>
  36 <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>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(Optional) Password for this line </em> <a href="#o5"></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#o6">threshold</a></td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threshold value for flood disconnect. </em> <a href="#o6"></a><em><br><br></td></tr>
  42 <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>
  43
  44 <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>
  45 <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>
  46
  47 <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>
  48 </table>
  49 <hr><a name="_details"></a><h2>Detailed Description</h2>
  50 Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  51 <p>
  52
  53 <p>
  54 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>
  55 <a name="a0" doxytag="ConnectClass::ConnectClass"></a><p>
  56 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  57   <tr>
  58     <td class="mdRow">
  59       <table cellpadding="0" cellspacing="0" border="0">
  60         <tr>
  61           <td class="md" nowrap valign="top"> ConnectClass::ConnectClass </td>
  62           <td class="md" valign="top">(&nbsp;</td>
  63           <td class="mdname1" valign="top" nowrap>          </td>
  64           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  65           <td class="md" nowrap><code> [inline]</code></td>
  66         </tr>
  67
  68       </table>
  69     </td>
  70   </tr>
  71 </table>
  72 <table cellspacing=5 cellpadding=0 border=0>
  73   <tr>
  74     <td>
  75       &nbsp;
  76     </td>
  77     <td>
  78
  79 <p>
  80
  81 <p>
  82 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>.
  83 <p>
  84 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>.
  85 <p>
  86 <div class="fragment"><pre>00080         {
  87 00081                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
  88 00082                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
  89 00083                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
  90 00084                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
  91 00085                 <a class="code" href="classConnectClass.html#o7">sendqmax</a> = 0;
  92 00086                 <a class="code" href="classConnectClass.html#o8">recvqmax</a> = 0;
  93 00087                 strlcpy(host,<span class="stringliteral">""</span>,MAXBUF);
  94 00088                 strlcpy(pass,<span class="stringliteral">""</span>,MAXBUF);
  95 00089         }
  96 </pre></div>    </td>
  97   </tr>
  98 </table>
  99 <hr><h2>Member Data Documentation</h2>
 100 <a name="o2" doxytag="ConnectClass::flood"></a><p>
 101 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 102   <tr>
 103     <td class="mdRow">
 104       <table cellpadding="0" cellspacing="0" border="0">
 105         <tr>
 106           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o2">ConnectClass::flood</a>
 107       </table>
 108     </td>
 109   </tr>
 110 </table>
 111 <table cellspacing=5 cellpadding=0 border=0>
 112   <tr>
 113     <td>
 114       &nbsp;
 115     </td>
 116     <td>
 117
 118 <p>
 119 Number of lines in buffer before excess flood is triggered.
 120 <p>
 121
 122 <p>
 123 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>.
 124 <p>
 125 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 126   </tr>
 127 </table>
 128 <a name="o3" doxytag="ConnectClass::host"></a><p>
 129 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 130   <tr>
 131     <td class="mdRow">
 132       <table cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o3">ConnectClass::host</a>[MAXBUF]
 135       </table>
 136     </td>
 137   </tr>
 138 </table>
 139 <table cellspacing=5 cellpadding=0 border=0>
 140   <tr>
 141     <td>
 142       &nbsp;
 143     </td>
 144     <td>
 145
 146 <p>
 147 Host mask for this line.
 148 <p>
 149
 150 <p>
 151 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>.
 152 <p>
 153 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 154   </tr>
 155 </table>
 156 <a name="o5" doxytag="ConnectClass::pass"></a><p>
 157 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 158   <tr>
 159     <td class="mdRow">
 160       <table cellpadding="0" cellspacing="0" border="0">
 161         <tr>
 162           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o5">ConnectClass::pass</a>[MAXBUF]
 163       </table>
 164     </td>
 165   </tr>
 166 </table>
 167 <table cellspacing=5 cellpadding=0 border=0>
 168   <tr>
 169     <td>
 170       &nbsp;
 171     </td>
 172     <td>
 173
 174 <p>
 175 (Optional) Password for this line
 176 <p>
 177
 178 <p>
 179 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>.
 180 <p>
 181 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 182   </tr>
 183 </table>
 184 <a name="o4" doxytag="ConnectClass::pingtime"></a><p>
 185 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 186   <tr>
 187     <td class="mdRow">
 188       <table cellpadding="0" cellspacing="0" border="0">
 189         <tr>
 190           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o4">ConnectClass::pingtime</a>
 191       </table>
 192     </td>
 193   </tr>
 194 </table>
 195 <table cellspacing=5 cellpadding=0 border=0>
 196   <tr>
 197     <td>
 198       &nbsp;
 199     </td>
 200     <td>
 201
 202 <p>
 203 Number of seconds between pings for this line.
 204 <p>
 205
 206 <p>
 207 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>.
 208 <p>
 209 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 210   </tr>
 211 </table>
 212 <a name="o8" doxytag="ConnectClass::recvqmax"></a><p>
 213 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 214   <tr>
 215     <td class="mdRow">
 216       <table cellpadding="0" cellspacing="0" border="0">
 217         <tr>
 218           <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o8">ConnectClass::recvqmax</a>
 219       </table>
 220     </td>
 221   </tr>
 222 </table>
 223 <table cellspacing=5 cellpadding=0 border=0>
 224   <tr>
 225     <td>
 226       &nbsp;
 227     </td>
 228     <td>
 229
 230 <p>
 231 Maximum size of recvq for users in this class (bytes).
 232 <p>
 233
 234 <p>
 235 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>.
 236 <p>
 237 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 238   </tr>
 239 </table>
 240 <a name="o1" doxytag="ConnectClass::registration_timeout"></a><p>
 241 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 242   <tr>
 243     <td class="mdRow">
 244       <table cellpadding="0" cellspacing="0" border="0">
 245         <tr>
 246           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o1">ConnectClass::registration_timeout</a>
 247       </table>
 248     </td>
 249   </tr>
 250 </table>
 251 <table cellspacing=5 cellpadding=0 border=0>
 252   <tr>
 253     <td>
 254       &nbsp;
 255     </td>
 256     <td>
 257
 258 <p>
 259 Max time to register the connection in seconds.
 260 <p>
 261
 262 <p>
 263 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>.
 264 <p>
 265 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 266   </tr>
 267 </table>
 268 <a name="o7" doxytag="ConnectClass::sendqmax"></a><p>
 269 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 270   <tr>
 271     <td class="mdRow">
 272       <table cellpadding="0" cellspacing="0" border="0">
 273         <tr>
 274           <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o7">ConnectClass::sendqmax</a>
 275       </table>
 276     </td>
 277   </tr>
 278 </table>
 279 <table cellspacing=5 cellpadding=0 border=0>
 280   <tr>
 281     <td>
 282       &nbsp;
 283     </td>
 284     <td>
 285
 286 <p>
 287 Maximum size of sendq for users in this class (bytes).
 288 <p>
 289
 290 <p>
 291 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>.
 292 <p>
 293 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 294   </tr>
 295 </table>
 296 <a name="o6" doxytag="ConnectClass::threshold"></a><p>
 297 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 298   <tr>
 299     <td class="mdRow">
 300       <table cellpadding="0" cellspacing="0" border="0">
 301         <tr>
 302           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o6">ConnectClass::threshold</a>
 303       </table>
 304     </td>
 305   </tr>
 306 </table>
 307 <table cellspacing=5 cellpadding=0 border=0>
 308   <tr>
 309     <td>
 310       &nbsp;
 311     </td>
 312     <td>
 313
 314 <p>
 315 Threshold value for flood disconnect.
 316 <p>
 317
 318 <p>
 319 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>.
 320 <p>
 321 Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
 322   </tr>
 323 </table>
 324 <a name="o0" doxytag="ConnectClass::type"></a><p>
 325 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 326   <tr>
 327     <td class="mdRow">
 328       <table cellpadding="0" cellspacing="0" border="0">
 329         <tr>
 330           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o0">ConnectClass::type</a>
 331       </table>
 332     </td>
 333   </tr>
 334 </table>
 335 <table cellspacing=5 cellpadding=0 border=0>
 336   <tr>
 337     <td>
 338       &nbsp;
 339     </td>
 340     <td>
 341
 342 <p>
 343 Type of line, either CC_ALLOW or CC_DENY.
 344 <p>
 345
 346 <p>
 347 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>
 348   </tr>
 349 </table>
 350 <hr>The documentation for this class was generated from the following file:<ul>
 351 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
 352 <hr size="1"><address style="align: right;"><small>Generated on Thu May 12 22:59:02 2005 for InspIRCd by
 353 <a href="http://www.doxygen.org/index.html">
 354 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 355 </a>1.3.3 </small></address>
 356 </body>
 357 </html>