diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-03-25 03:51:56 +0000 |
| commit | 52899de0ff2d62ca0542b243c41626010bf62083 (patch) | |
| tree | b9c92bbdb7d65a7467cbd6ebcbc31dc2f96e09e3 /docs/module-doc/classConnectClass.html | |
| parent | 0340f1a432d684347d8dbc3aa85c8436c56d4039 (diff) | |
Documentation update
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classConnectClass.html')
| -rw-r--r-- | docs/module-doc/classConnectClass.html | 151 |
1 files changed, 80 insertions, 71 deletions
diff --git a/docs/module-doc/classConnectClass.html b/docs/module-doc/classConnectClass.html index 361951c86..dfddf30a3 100644 --- a/docs/module-doc/classConnectClass.html +++ b/docs/module-doc/classConnectClass.html @@ -1,56 +1,55 @@ <!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> +<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> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> -<hr><h1>ConnectClass Class Reference</h1>Holds information relevent to <connect allow> and <connect deny> tags in the config file. +<!-- Generated by Doxygen 1.3.3 --> +<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>ConnectClass Class Reference</h1>Holds information relevent to <connect allow> and <connect deny> tags in the config file. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="users_8h-source.html">users.h</a>></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 nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classConnectClass.html#a0">ConnectClass</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </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 </td><td valign=bottom><a class="el" href="classConnectClass.html#m0">type</a></td></tr> -<tr><td> </td><td><font size=-1><em>Type of line, either CC_ALLOW or CC_DENY.</em> <a href="#m0"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classConnectClass.html#m1">registration_timeout</a></td></tr> -<tr><td> </td><td><font size=-1><em>Max time to register the connection in seconds.</em> <a href="#m1"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classConnectClass.html#m2">flood</a></td></tr> -<tr><td> </td><td><font size=-1><em>Number of lines in buffer before excess flood is triggered.</em> <a href="#m2"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classConnectClass.html#m3">host</a> [MAXBUF]</td></tr> -<tr><td> </td><td><font size=-1><em>Host mask for this line.</em> <a href="#m3"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classConnectClass.html#m4">pass</a> [MAXBUF]</td></tr> -<tr><td> </td><td><font size=-1><em>(Optional) Password for this line</em> <a href="#m4"></a><em></em></font><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o0">type</a></td></tr> + +<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o1">registration_timeout</a></td></tr> + +<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o2">flood</a></td></tr> + +<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o3">host</a> [MAXBUF]</td></tr> + +<tr><td class="mdescLeft"> </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>char </td><td class="memItemRight" valign=bottom><a class="el" href="classConnectClass.html#o4">pass</a> [MAXBUF]</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(Optional) Password for this line </em> <a href="#o4"></a><em><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> -Holds information relevent to <connect allow> and <connect deny> tags in the config file. +Holds information relevent to <connect allow> and <connect deny> tags in the config file. <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>Constructor & Destructor Documentation</h2> +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 & Destructor Documentation</h2> <a name="a0" doxytag="ConnectClass::ConnectClass"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<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"> ConnectClass::ConnectClass </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> @@ -68,25 +67,27 @@ Definition at line <a class="el" href="users_8h-source.html#l00034">34</a> of fi <p> <p> -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>. +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>. +<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#l00062">pass</a>, and <a class="el" href="users_8h-source.html#l00053">registration_timeout</a>. <p> -<div class="fragment"><pre>00054 { -00055 <a class="code" href="classConnectClass.html#m1">registration_timeout</a> = 0; -00056 <a class="code" href="classConnectClass.html#m2">flood</a> = 0; -00057 strcpy(host,<span class="stringliteral">""</span>); -00058 strcpy(pass,<span class="stringliteral">""</span>); -00059 } +<div class="fragment"><pre>00065 { +00066 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0; +00067 <a class="code" href="classConnectClass.html#o2">flood</a> = 0; +00068 strlcpy(host,<span class="stringliteral">""</span>,MAXBUF); +00069 strlcpy(pass,<span class="stringliteral">""</span>,MAXBUF); +00070 } </pre></div> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="m2" doxytag="ConnectClass::flood"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o2" doxytag="ConnectClass::flood"></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::flood + <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o2">ConnectClass::flood</a> </table> </td> </tr> @@ -99,20 +100,22 @@ Definition at line <a class="el" href="users_8h-source.html#l00053">53</a> of fi <td> <p> -Number of lines in buffer before excess flood is triggered. +Number of lines in buffer before excess flood is triggered. <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>. </td> +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#l00064">ConnectClass()</a>. </td> </tr> </table> -<a name="m3" doxytag="ConnectClass::host"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o3" doxytag="ConnectClass::host"></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"> char <a class="el" href="classConnectClass.html#o3">ConnectClass::host</a>[MAXBUF] </table> </td> </tr> @@ -125,20 +128,22 @@ Definition at line <a class="el" href="users_8h-source.html#l00045">45</a> of fi <td> <p> -Host mask for this line. +Host mask for this line. <p> <p> -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>. </td> +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#l00064">ConnectClass()</a>. </td> </tr> </table> -<a name="m4" doxytag="ConnectClass::pass"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o4" doxytag="ConnectClass::pass"></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"> char <a class="el" href="classConnectClass.html#o4">ConnectClass::pass</a>[MAXBUF] </table> </td> </tr> @@ -151,20 +156,22 @@ Definition at line <a class="el" href="users_8h-source.html#l00048">48</a> of fi <td> <p> -(Optional) Password for this line +(Optional) Password for this line <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00051">51</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#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#l00064">ConnectClass()</a>. </td> </tr> </table> -<a name="m1" doxytag="ConnectClass::registration_timeout"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<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"> int ConnectClass::registration_timeout + <td class="md" nowrap valign="top"> int <a class="el" href="classConnectClass.html#o1">ConnectClass::registration_timeout</a> </table> </td> </tr> @@ -177,20 +184,22 @@ Definition at line <a class="el" href="users_8h-source.html#l00051">51</a> of fi <td> <p> -Max time to register the connection in seconds. +Max time to register the connection in seconds. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00042">42</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#l00064">ConnectClass()</a>. </td> </tr> </table> -<a name="m0" doxytag="ConnectClass::type"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o0" doxytag="ConnectClass::type"></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#o0">ConnectClass::type</a> </table> </td> </tr> @@ -203,18 +212,18 @@ Definition at line <a class="el" href="users_8h-source.html#l00042">42</a> of fi <td> <p> -Type of line, either CC_ALLOW or CC_DENY. +Type of line, either CC_ALLOW or CC_DENY. <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#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 May 2 00:09:33 2004 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Mar 25 03:49:31 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> |