]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/classConnectClass.html
Added docs for new smaller memory footprint classes
[user/henk/code/inspircd.git] / docs / module-doc / classConnectClass.html
index e7dcf8c6e244f812ab2672a0769cf64dd635e172..170e519764768b122aad2d6b58900d00e7a77f31 100644 (file)
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>ConnectClass class Reference</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<title>InspIRCd: ConnectClass class Reference</title>
+<link href="inspircd.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.3-rc3 -->
-<center>
-<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
-<hr><h1>ConnectClass Class Reference</h1>Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file. 
+<!-- Generated by Doxygen 1.3.3 -->
+<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>
+<h1>ConnectClass Class Reference</h1>Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.  
 <a href="#_details">More...</a>
 <p>
 <code>#include &lt;<a class="el" href="users_8h-source.html">users.h</a>&gt;</code>
 <p>
-Inheritance diagram for ConnectClass:<p><center><img src="classConnectClass__inherit__graph.gif" border="0" usemap="#ConnectClass__inherit__map" alt="Inheritance graph"></center>
-<map name="ConnectClass__inherit__map">
-<area href="classclassbase.html" shape="rect" coords="17,16,84,37" alt="">
-</map>
-<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>
-<map name="ConnectClass__coll__map">
-<area href="classclassbase.html" shape="rect" coords="7,107,73,128" alt="">
-</map>
-<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>
+Inherits <a class="el" href="classclassbase.html">classbase</a>.
+<p>
+<a href="classConnectClass-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
 <tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<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>
+
 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m0">type</a></td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m1">host</a> [MAXBUF]</td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html#m2">pass</a> [MAXBUF]</td></tr>
+<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>
+
+<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>
+<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>
+
+<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>
+<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>
+
+<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>
+<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>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host mask for this line. </em> <a href="#o3"></a><em><br><br></td></tr>
+<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>
+
+<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>
+<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>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">(Optional) Password for this line </em> <a href="#o5"></a><em><br><br></td></tr>
+<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>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Threshold value for flood disconnect. </em> <a href="#o6"></a><em><br><br></td></tr>
+<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>
+
+<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>
+<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>
+
+<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>
 </table>
 <hr><a name="_details"></a><h2>Detailed Description</h2>
-Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
+Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file. 
+<p>
+
+<p>
+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>
+<a name="a0" doxytag="ConnectClass::ConnectClass"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> ConnectClass::ConnectClass </td>
+          <td class="md" valign="top">(&nbsp;</td>
+          <td class="mdname1" valign="top" nowrap>          </td>
+          <td class="md" valign="top">&nbsp;)&nbsp;</td>
+          <td class="md" nowrap><code> [inline]</code></td>
+        </tr>
+
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+
+<p>
+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>.
+<p>
+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>.
+<p>
+<div class="fragment"><pre>00080         {
+00081                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
+00082                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
+00083                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
+00084                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
+00085                 <a class="code" href="classConnectClass.html#o7">sendqmax</a> = 0;
+00086                 <a class="code" href="classConnectClass.html#o8">recvqmax</a> = 0;
+00087                 strlcpy(host,<span class="stringliteral">""</span>,MAXBUF);
+00088                 strlcpy(pass,<span class="stringliteral">""</span>,MAXBUF);
+00089         }
+</pre></div>    </td>
+  </tr>
+</table>
+<hr><h2>Member Data Documentation</h2>
+<a name="o2" doxytag="ConnectClass::flood"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o2">ConnectClass::flood</a>
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Number of lines in buffer before excess flood is triggered. 
+<p>
+
+<p>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
+  </tr>
+</table>
+<a name="o3" doxytag="ConnectClass::host"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o3">ConnectClass::host</a>[MAXBUF]
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Host mask for this line. 
+<p>
+
+<p>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
+  </tr>
+</table>
+<a name="o5" doxytag="ConnectClass::pass"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o5">ConnectClass::pass</a>[MAXBUF]
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+(Optional) Password for this line 
+<p>
+
+<p>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
+  </tr>
+</table>
+<a name="o4" doxytag="ConnectClass::pingtime"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o4">ConnectClass::pingtime</a>
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Number of seconds between pings for this line. 
+<p>
+
+<p>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
+  </tr>
+</table>
+<a name="o8" doxytag="ConnectClass::recvqmax"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o8">ConnectClass::recvqmax</a>
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Maximum size of recvq for users in this class (bytes). 
 <p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00034">34</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Member Data Documentation</h2>
-<a name="m1" doxytag="ConnectClass::host"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
+  </tr>
+</table>
+<a name="o1" doxytag="ConnectClass::registration_timeout"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
-    <td class="md">
+    <td class="mdRow">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> char ConnectClass::host[MAXBUF]
+          <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o1">ConnectClass::registration_timeout</a>
       </table>
     </td>
   </tr>
@@ -51,18 +256,22 @@ Definition at line <a class="el" href="users_8h-source.html#l00034">34</a> of fi
     <td>
 
 <p>
+Max time to register the connection in seconds. 
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00038">38</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
   </tr>
 </table>
-<a name="m2" doxytag="ConnectClass::pass"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<a name="o7" doxytag="ConnectClass::sendqmax"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
-    <td class="md">
+    <td class="mdRow">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> char ConnectClass::pass[MAXBUF]
+          <td class="md" nowrap valign="top"> long <a class="el" href="classConnectClass.html#o7">ConnectClass::sendqmax</a>
       </table>
     </td>
   </tr>
@@ -75,18 +284,22 @@ Definition at line <a class="el" href="users_8h-source.html#l00038">38</a> of fi
     <td>
 
 <p>
+Maximum size of sendq for users in this class (bytes). 
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00039">39</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
   </tr>
 </table>
-<a name="m0" doxytag="ConnectClass::type"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
+<a name="o6" doxytag="ConnectClass::threshold"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
   <tr>
-    <td class="md">
+    <td class="mdRow">
       <table cellpadding="0" cellspacing="0" border="0">
         <tr>
-          <td class="md" nowrap valign="top"> int ConnectClass::type
+          <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o6">ConnectClass::threshold</a>
       </table>
     </td>
   </tr>
@@ -99,16 +312,46 @@ Definition at line <a class="el" href="users_8h-source.html#l00039">39</a> of fi
     <td>
 
 <p>
+Threshold value for flood disconnect. 
+<p>
+
+<p>
+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>.
+<p>
+Referenced by <a class="el" href="users_8h-source.html#l00079">ConnectClass()</a>.    </td>
+  </tr>
+</table>
+<a name="o0" doxytag="ConnectClass::type"></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+  <tr>
+    <td class="mdRow">
+      <table cellpadding="0" cellspacing="0" border="0">
+        <tr>
+          <td class="md" nowrap valign="top"> char <a class="el" href="classConnectClass.html#o0">ConnectClass::type</a>
+      </table>
+    </td>
+  </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+  <tr>
+    <td>
+      &nbsp;
+    </td>
+    <td>
+
+<p>
+Type of line, either CC_ALLOW or CC_DENY. 
+<p>
 
 <p>
-Definition at line <a class="el" href="users_8h-source.html#l00037">37</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
+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>
   </tr>
 </table>
 <hr>The documentation for this class was generated from the following file:<ul>
 <li><a class="el" href="users_8h-source.html">users.h</a></ul>
-<hr><address style="align: right;"><small>Generated on Sun Mar 30 19:35:50 2003 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Thu May 12 22:59:02 2005 for InspIRCd by
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border=0 
-width=110 height=53></a>1.3-rc3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 
+</a>1.3.3 </small></address>
 </body>
 </html>