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>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>long&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 </table>
  43 <hr><a name="_details"></a><h2>Detailed Description</h2>
  44 Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  45 <p>
  46
  47 <p>
  48 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>
  49 <a name="a0" doxytag="ConnectClass::ConnectClass"></a><p>
  50 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  51   <tr>
  52     <td class="mdRow">
  53       <table cellpadding="0" cellspacing="0" border="0">
  54         <tr>
  55           <td class="md" nowrap valign="top"> ConnectClass::ConnectClass </td>
  56           <td class="md" valign="top">(&nbsp;</td>
  57           <td class="mdname1" valign="top" nowrap>          </td>
  58           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  59           <td class="md" nowrap><code> [inline]</code></td>
  60         </tr>
  61
  62       </table>
  63     </td>
  64   </tr>
  65 </table>
  66 <table cellspacing=5 cellpadding=0 border=0>
  67   <tr>
  68     <td>
  69       &nbsp;
  70     </td>
  71     <td>
  72
  73 <p>
  74
  75 <p>
  76 Definition at line <a class="el" href="users_8h-source.html#l00071">71</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
  77 <p>
  78 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#l00053">registration_timeout</a>, and <a class="el" href="users_8h-source.html#l00069">threshold</a>.
  79 <p>
  80 <div class="fragment"><pre>00072         {
  81 00073                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
  82 00074                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
  83 00075                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
  84 00076                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
  85 00077                 strlcpy(host,<span class="stringliteral">""</span>,MAXBUF);
  86 00078                 strlcpy(pass,<span class="stringliteral">""</span>,MAXBUF);
  87 00079         }
  88 </pre></div>    </td>
  89   </tr>
  90 </table>
  91 <hr><h2>Member Data Documentation</h2>
  92 <a name="o2" doxytag="ConnectClass::flood"></a><p>
  93 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  94   <tr>
  95     <td class="mdRow">
  96       <table cellpadding="0" cellspacing="0" border="0">
  97         <tr>
  98           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o2">ConnectClass::flood</a>
  99       </table>
 100     </td>
 101   </tr>
 102 </table>
 103 <table cellspacing=5 cellpadding=0 border=0>
 104   <tr>
 105     <td>
 106       &nbsp;
 107     </td>
 108     <td>
 109
 110 <p>
 111 Number of lines in buffer before excess flood is triggered.
 112 <p>
 113
 114 <p>
 115 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>.
 116 <p>
 117 Referenced by <a class="el" href="users_8h-source.html#l00071">ConnectClass()</a>.    </td>
 118   </tr>
 119 </table>
 120 <a name="o3" doxytag="ConnectClass::host"></a><p>
 121 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 122   <tr>
 123     <td class="mdRow">
 124       <table cellpadding="0" cellspacing="0" border="0">
 125         <tr>
 126           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o3">ConnectClass::host</a>[MAXBUF]
 127       </table>
 128     </td>
 129   </tr>
 130 </table>
 131 <table cellspacing=5 cellpadding=0 border=0>
 132   <tr>
 133     <td>
 134       &nbsp;
 135     </td>
 136     <td>
 137
 138 <p>
 139 Host mask for this line.
 140 <p>
 141
 142 <p>
 143 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>.
 144 <p>
 145 Referenced by <a class="el" href="users_8h-source.html#l00071">ConnectClass()</a>.    </td>
 146   </tr>
 147 </table>
 148 <a name="o5" doxytag="ConnectClass::pass"></a><p>
 149 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 150   <tr>
 151     <td class="mdRow">
 152       <table cellpadding="0" cellspacing="0" border="0">
 153         <tr>
 154           <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o5">ConnectClass::pass</a>[MAXBUF]
 155       </table>
 156     </td>
 157   </tr>
 158 </table>
 159 <table cellspacing=5 cellpadding=0 border=0>
 160   <tr>
 161     <td>
 162       &nbsp;
 163     </td>
 164     <td>
 165
 166 <p>
 167 (Optional) Password for this line
 168 <p>
 169
 170 <p>
 171 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>.
 172 <p>
 173 Referenced by <a class="el" href="users_8h-source.html#l00071">ConnectClass()</a>.    </td>
 174   </tr>
 175 </table>
 176 <a name="o4" doxytag="ConnectClass::pingtime"></a><p>
 177 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 178   <tr>
 179     <td class="mdRow">
 180       <table cellpadding="0" cellspacing="0" border="0">
 181         <tr>
 182           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o4">ConnectClass::pingtime</a>
 183       </table>
 184     </td>
 185   </tr>
 186 </table>
 187 <table cellspacing=5 cellpadding=0 border=0>
 188   <tr>
 189     <td>
 190       &nbsp;
 191     </td>
 192     <td>
 193
 194 <p>
 195 Number of seconds between pings for this line.
 196 <p>
 197
 198 <p>
 199 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>.
 200 <p>
 201 Referenced by <a class="el" href="users_8h-source.html#l00071">ConnectClass()</a>.    </td>
 202   </tr>
 203 </table>
 204 <a name="o1" doxytag="ConnectClass::registration_timeout"></a><p>
 205 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 206   <tr>
 207     <td class="mdRow">
 208       <table cellpadding="0" cellspacing="0" border="0">
 209         <tr>
 210           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o1">ConnectClass::registration_timeout</a>
 211       </table>
 212     </td>
 213   </tr>
 214 </table>
 215 <table cellspacing=5 cellpadding=0 border=0>
 216   <tr>
 217     <td>
 218       &nbsp;
 219     </td>
 220     <td>
 221
 222 <p>
 223 Max time to register the connection in seconds.
 224 <p>
 225
 226 <p>
 227 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>.
 228 <p>
 229 Referenced by <a class="el" href="users_8h-source.html#l00071">ConnectClass()</a>.    </td>
 230   </tr>
 231 </table>
 232 <a name="o6" doxytag="ConnectClass::threshold"></a><p>
 233 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 234   <tr>
 235     <td class="mdRow">
 236       <table cellpadding="0" cellspacing="0" border="0">
 237         <tr>
 238           <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o6">ConnectClass::threshold</a>
 239       </table>
 240     </td>
 241   </tr>
 242 </table>
 243 <table cellspacing=5 cellpadding=0 border=0>
 244   <tr>
 245     <td>
 246       &nbsp;
 247     </td>
 248     <td>
 249
 250 <p>
 251 Threshold value for flood disconnect.
 252 <p>
 253
 254 <p>
 255 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>.
 256 <p>
 257 Referenced by <a class="el" href="users_8h-source.html#l00071">ConnectClass()</a>.    </td>
 258   </tr>
 259 </table>
 260 <a name="o0" doxytag="ConnectClass::type"></a><p>
 261 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 262   <tr>
 263     <td class="mdRow">
 264       <table cellpadding="0" cellspacing="0" border="0">
 265         <tr>
 266           <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o0">ConnectClass::type</a>
 267       </table>
 268     </td>
 269   </tr>
 270 </table>
 271 <table cellspacing=5 cellpadding=0 border=0>
 272   <tr>
 273     <td>
 274       &nbsp;
 275     </td>
 276     <td>
 277
 278 <p>
 279 Type of line, either CC_ALLOW or CC_DENY.
 280 <p>
 281
 282 <p>
 283 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>
 284   </tr>
 285 </table>
 286 <hr>The documentation for this class was generated from the following file:<ul>
 287 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
 288 <hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:24 2005 for InspIRCd by
 289 <a href="http://www.doxygen.org/index.html">
 290 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 291 </a>1.3.3 </small></address>
 292 </body>
 293 </html>