docs/module-doc/classConnectClass.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 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.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   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">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ConnectClass Class Reference</h1><!-- doxytag: class="ConnectClass" --><!-- doxytag: inherits="classbase" -->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="19,7,99,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="7,97,87,124" 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#ConnectClass_28_29">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#type">type</a></td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of line, either CC_ALLOW or CC_DENY.  <a href="#type"></a><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#registration_5Ftimeout">registration_timeout</a></td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Max time to register the connection in seconds.  <a href="#registration_5Ftimeout"></a><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#flood">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.  <a href="#flood"></a><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#host_5BMAXBUF_5D">host</a> [MAXBUF]</td></tr>
  37
  38 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host mask for this line.  <a href="#host_5BMAXBUF_5D"></a><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#pingtime">pingtime</a></td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of seconds between pings for this line.  <a href="#pingtime"></a><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#pass_5BMAXBUF_5D">pass</a> [MAXBUF]</td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(Optional) Password for this line  <a href="#pass_5BMAXBUF_5D"></a><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#threshold">threshold</a></td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threshold value for flood disconnect.  <a href="#threshold"></a><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#sendqmax">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).  <a href="#sendqmax"></a><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#recvqmax">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).  <a href="#recvqmax"></a><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#l00048">48</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  61 <a class="anchor" name="ConnectClass_28_29"></a><!-- doxytag: member="ConnectClass::ConnectClass" ref="ConnectClass_28_29" args="()" --><p>
  62 <table class="mdTable" 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       </table>
  74     </td>
  75   </tr>
  76 </table>
  77 <table cellspacing="5" cellpadding="0" border="0">
  78   <tr>
  79     <td>
  80       &nbsp;
  81     </td>
  82     <td>
  83
  84 <p>
  85
  86 <p>
  87 Definition at line <a class="el" href="users_8h-source.html#l00082">82</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
  88 <p>
  89 References <a class="el" href="users_8h-source.html#l00059">flood</a>, <a class="el" href="users_8h-source.html#l00062">host</a>, <a class="el" href="users_8h-source.html#l00068">pass</a>, <a class="el" href="users_8h-source.html#l00065">pingtime</a>, <a class="el" href="users_8h-source.html#l00080">recvqmax</a>, <a class="el" href="users_8h-source.html#l00056">registration_timeout</a>, <a class="el" href="users_8h-source.html#l00076">sendqmax</a>, and <a class="el" href="users_8h-source.html#l00072">threshold</a>.<div class="fragment"><pre class="fragment"><a name="l00083"></a>00083         {
  90 <a name="l00084"></a>00084                 <a class="code" href="classConnectClass.html#registration_5Ftimeout">registration_timeout</a> = 0;
  91 <a name="l00085"></a>00085                 <a class="code" href="classConnectClass.html#flood">flood</a> = 0;
  92 <a name="l00086"></a>00086                 <a class="code" href="classConnectClass.html#pingtime">pingtime</a> = 0;
  93 <a name="l00087"></a>00087                 <a class="code" href="classConnectClass.html#threshold">threshold</a> = 0;
  94 <a name="l00088"></a>00088                 <a class="code" href="classConnectClass.html#sendqmax">sendqmax</a> = 0;
  95 <a name="l00089"></a>00089                 <a class="code" href="classConnectClass.html#recvqmax">recvqmax</a> = 0;
  96 <a name="l00090"></a>00090                 strlcpy(<a class="code" href="classConnectClass.html#host_5BMAXBUF_5D">host</a>,<span class="stringliteral">""</span>,MAXBUF);
  97 <a name="l00091"></a>00091                 strlcpy(<a class="code" href="classConnectClass.html#pass_5BMAXBUF_5D">pass</a>,<span class="stringliteral">""</span>,MAXBUF);
  98 <a name="l00092"></a>00092         }
  99 </pre></div>
 100 <p>
 101     </td>
 102   </tr>
 103 </table>
 104 <hr><h2>Member Data Documentation</h2>
 105 <a class="anchor" name="flood"></a><!-- doxytag: member="ConnectClass::flood" ref="flood" args="" --><p>
 106 <table class="mdTable" cellpadding="2" cellspacing="0">
 107   <tr>
 108     <td class="mdRow">
 109       <table cellpadding="0" cellspacing="0" border="0">
 110         <tr>
 111           <td class="md" nowrap valign="top">int <a class="el" href="classConnectClass.html#flood">ConnectClass::flood</a>          </td>
 112         </tr>
 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#l00059">59</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#l00082">ConnectClass()</a>.    </td>
 132   </tr>
 133 </table>
 134 <a class="anchor" name="host_5BMAXBUF_5D"></a><!-- doxytag: member="ConnectClass::host" ref="host_5BMAXBUF_5D" args="[MAXBUF]" --><p>
 135 <table class="mdTable" 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#host_5BMAXBUF_5D">ConnectClass::host</a>[MAXBUF]          </td>
 141         </tr>
 142       </table>
 143     </td>
 144   </tr>
 145 </table>
 146 <table cellspacing="5" cellpadding="0" border="0">
 147   <tr>
 148     <td>
 149       &nbsp;
 150     </td>
 151     <td>
 152
 153 <p>
 154 Host mask for this line.
 155 <p>
 156
 157 <p>
 158 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>.
 159 <p>
 160 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 161   </tr>
 162 </table>
 163 <a class="anchor" name="pass_5BMAXBUF_5D"></a><!-- doxytag: member="ConnectClass::pass" ref="pass_5BMAXBUF_5D" args="[MAXBUF]" --><p>
 164 <table class="mdTable" cellpadding="2" cellspacing="0">
 165   <tr>
 166     <td class="mdRow">
 167       <table cellpadding="0" cellspacing="0" border="0">
 168         <tr>
 169           <td class="md" nowrap valign="top">char <a class="el" href="classConnectClass.html#pass_5BMAXBUF_5D">ConnectClass::pass</a>[MAXBUF]          </td>
 170         </tr>
 171       </table>
 172     </td>
 173   </tr>
 174 </table>
 175 <table cellspacing="5" cellpadding="0" border="0">
 176   <tr>
 177     <td>
 178       &nbsp;
 179     </td>
 180     <td>
 181
 182 <p>
 183 (Optional) Password for this line
 184 <p>
 185
 186 <p>
 187 Definition at line <a class="el" href="users_8h-source.html#l00068">68</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 188 <p>
 189 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 190   </tr>
 191 </table>
 192 <a class="anchor" name="pingtime"></a><!-- doxytag: member="ConnectClass::pingtime" ref="pingtime" args="" --><p>
 193 <table class="mdTable" cellpadding="2" cellspacing="0">
 194   <tr>
 195     <td class="mdRow">
 196       <table cellpadding="0" cellspacing="0" border="0">
 197         <tr>
 198           <td class="md" nowrap valign="top">int <a class="el" href="classConnectClass.html#pingtime">ConnectClass::pingtime</a>          </td>
 199         </tr>
 200       </table>
 201     </td>
 202   </tr>
 203 </table>
 204 <table cellspacing="5" cellpadding="0" border="0">
 205   <tr>
 206     <td>
 207       &nbsp;
 208     </td>
 209     <td>
 210
 211 <p>
 212 Number of seconds between pings for this line.
 213 <p>
 214
 215 <p>
 216 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>.
 217 <p>
 218 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 219   </tr>
 220 </table>
 221 <a class="anchor" name="recvqmax"></a><!-- doxytag: member="ConnectClass::recvqmax" ref="recvqmax" args="" --><p>
 222 <table class="mdTable" cellpadding="2" cellspacing="0">
 223   <tr>
 224     <td class="mdRow">
 225       <table cellpadding="0" cellspacing="0" border="0">
 226         <tr>
 227           <td class="md" nowrap valign="top">long <a class="el" href="classConnectClass.html#recvqmax">ConnectClass::recvqmax</a>          </td>
 228         </tr>
 229       </table>
 230     </td>
 231   </tr>
 232 </table>
 233 <table cellspacing="5" cellpadding="0" border="0">
 234   <tr>
 235     <td>
 236       &nbsp;
 237     </td>
 238     <td>
 239
 240 <p>
 241 Maximum size of recvq for users in this class (bytes).
 242 <p>
 243
 244 <p>
 245 Definition at line <a class="el" href="users_8h-source.html#l00080">80</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 246 <p>
 247 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 248   </tr>
 249 </table>
 250 <a class="anchor" name="registration_5Ftimeout"></a><!-- doxytag: member="ConnectClass::registration_timeout" ref="registration_5Ftimeout" args="" --><p>
 251 <table class="mdTable" cellpadding="2" cellspacing="0">
 252   <tr>
 253     <td class="mdRow">
 254       <table cellpadding="0" cellspacing="0" border="0">
 255         <tr>
 256           <td class="md" nowrap valign="top">int <a class="el" href="classConnectClass.html#registration_5Ftimeout">ConnectClass::registration_timeout</a>          </td>
 257         </tr>
 258       </table>
 259     </td>
 260   </tr>
 261 </table>
 262 <table cellspacing="5" cellpadding="0" border="0">
 263   <tr>
 264     <td>
 265       &nbsp;
 266     </td>
 267     <td>
 268
 269 <p>
 270 Max time to register the connection in seconds.
 271 <p>
 272
 273 <p>
 274 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>.
 275 <p>
 276 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 277   </tr>
 278 </table>
 279 <a class="anchor" name="sendqmax"></a><!-- doxytag: member="ConnectClass::sendqmax" ref="sendqmax" args="" --><p>
 280 <table class="mdTable" cellpadding="2" cellspacing="0">
 281   <tr>
 282     <td class="mdRow">
 283       <table cellpadding="0" cellspacing="0" border="0">
 284         <tr>
 285           <td class="md" nowrap valign="top">long <a class="el" href="classConnectClass.html#sendqmax">ConnectClass::sendqmax</a>          </td>
 286         </tr>
 287       </table>
 288     </td>
 289   </tr>
 290 </table>
 291 <table cellspacing="5" cellpadding="0" border="0">
 292   <tr>
 293     <td>
 294       &nbsp;
 295     </td>
 296     <td>
 297
 298 <p>
 299 Maximum size of sendq for users in this class (bytes).
 300 <p>
 301
 302 <p>
 303 Definition at line <a class="el" href="users_8h-source.html#l00076">76</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 304 <p>
 305 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 306   </tr>
 307 </table>
 308 <a class="anchor" name="threshold"></a><!-- doxytag: member="ConnectClass::threshold" ref="threshold" args="" --><p>
 309 <table class="mdTable" cellpadding="2" cellspacing="0">
 310   <tr>
 311     <td class="mdRow">
 312       <table cellpadding="0" cellspacing="0" border="0">
 313         <tr>
 314           <td class="md" nowrap valign="top">int <a class="el" href="classConnectClass.html#threshold">ConnectClass::threshold</a>          </td>
 315         </tr>
 316       </table>
 317     </td>
 318   </tr>
 319 </table>
 320 <table cellspacing="5" cellpadding="0" border="0">
 321   <tr>
 322     <td>
 323       &nbsp;
 324     </td>
 325     <td>
 326
 327 <p>
 328 Threshold value for flood disconnect.
 329 <p>
 330
 331 <p>
 332 Definition at line <a class="el" href="users_8h-source.html#l00072">72</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 333 <p>
 334 Referenced by <a class="el" href="users_8h-source.html#l00082">ConnectClass()</a>.    </td>
 335   </tr>
 336 </table>
 337 <a class="anchor" name="type"></a><!-- doxytag: member="ConnectClass::type" ref="type" args="" --><p>
 338 <table class="mdTable" cellpadding="2" cellspacing="0">
 339   <tr>
 340     <td class="mdRow">
 341       <table cellpadding="0" cellspacing="0" border="0">
 342         <tr>
 343           <td class="md" nowrap valign="top">char <a class="el" href="classConnectClass.html#type">ConnectClass::type</a>          </td>
 344         </tr>
 345       </table>
 346     </td>
 347   </tr>
 348 </table>
 349 <table cellspacing="5" cellpadding="0" border="0">
 350   <tr>
 351     <td>
 352       &nbsp;
 353     </td>
 354     <td>
 355
 356 <p>
 357 Type of line, either CC_ALLOW or CC_DENY.
 358 <p>
 359
 360 <p>
 361 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>.    </td>
 362   </tr>
 363 </table>
 364 <hr>The documentation for this class was generated from the following file:<ul>
 365 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
 366 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 18:31:02 2005 for InspIRCd by&nbsp;
 367 <a href="http://www.doxygen.org/index.html">
 368 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 369 </body>
 370 </html>