docs/module-doc/users_8h.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>users.h File Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</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>
   9 <hr><h1>users.h File Reference</h1><code>#include "inspircd_config.h"</code><br>
  10 <code>#include "<a class="el" href="channels_8h-source.html">channels.h</a>"</code><br>
  11 <code>#include "<a class="el" href="connection_8h-source.html">connection.h</a>"</code><br>
  12 <code>#include &lt;string&gt;</code><br>
  13
  14 <p>
  15 Include dependency graph for users.h:<p><center><img src="users_8h__incl.gif" border="0" usemap="#users.h_map" alt="Include dependency graph"></center>
  16 <map name="users.h_map">
  17 <area href="channels_8h.html" shape="rect" coords="57,85,129,106" alt="">
  18 <area href="connection_8h.html" shape="rect" coords="153,85,233,106" alt="">
  19 </map>
  20
  21 <p>
  22 This graph shows which files directly or indirectly include this file:<p><center><img src="users_8h__dep__incl.gif" border="0" usemap="#users.hdep_map" alt="Included by dependency graph"></center>
  23 <map name="users.hdep_map">
  24 <area href="channels_8cpp.html" shape="rect" coords="373,16,461,37" alt="">
  25 <area href="message_8h.html" shape="rect" coords="327,85,399,106" alt="">
  26 <area href="mode_8h.html" shape="rect" coords="423,85,473,106" alt="">
  27 <area href="xline_8h.html" shape="rect" coords="255,85,303,106" alt="">
  28 <area href="modules_8cpp.html" shape="rect" coords="237,16,320,37" alt="">
  29 <area href="commands_8h.html" shape="rect" coords="57,85,140,106" alt="">
  30 <area href="users_8cpp.html" shape="rect" coords="164,85,231,106" alt="">
  31 </map>
  32
  33 <p>
  34 <a href="users_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  35 <tr><td></td></tr>
  36 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  37 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html">ConnectClass</a></td></tr>
  38 <tr><td>&nbsp;</td><td><font size=-1><em>Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.</em> <a href="classConnectClass.html#_details">More...</a><em></em></font><br><br></td></tr>
  39 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classInvited.html">Invited</a></td></tr>
  40 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a channel name to which a user has been invited.</em> <a href="classInvited.html#_details">More...</a><em></em></font><br><br></td></tr>
  41 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html">userrec</a></td></tr>
  42 <tr><td>&nbsp;</td><td><font size=-1><em>Holds all information about a user This class stores all information about a user connected to the irc server.</em> <a href="classuserrec.html#_details">More...</a><em></em></font><br><br></td></tr>
  43 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  44 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a0">STATUS_OP</a>&nbsp;&nbsp;&nbsp;4</td></tr>
  45 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a1">STATUS_HOP</a>&nbsp;&nbsp;&nbsp;2</td></tr>
  46 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a2">STATUS_VOICE</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  47 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a3">STATUS_NORMAL</a>&nbsp;&nbsp;&nbsp;0</td></tr>
  48 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a4">CC_ALLOW</a>&nbsp;&nbsp;&nbsp;0</td></tr>
  49 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a5">CC_DENY</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  50 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  51 <tr><td nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classInvited.html">Invited</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a6">InvitedList</a></td></tr>
  52 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a complete list of all channels to which a user has been invited and has not yet joined.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
  53 <tr><td nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classConnectClass.html">ConnectClass</a> &gt;&nbsp;</td><td valign=bottom><a class="el" href="users_8h.html#a7">ClassVector</a></td></tr>
  54 <tr><td>&nbsp;</td><td><font size=-1><em>Holds a complete list of all allow and deny tags from the configuration file (connection classes).</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
  55 </table>
  56 <hr><h2>Define Documentation</h2>
  57 <a name="a4" doxytag="users.h::CC_ALLOW"></a><p>
  58 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  59   <tr>
  60     <td class="md">
  61       <table cellpadding="0" cellspacing="0" border="0">
  62         <tr>
  63           <td class="md" nowrap valign="top"> #define CC_ALLOW&nbsp;&nbsp;&nbsp;0
  64       </table>
  65     </td>
  66   </tr>
  67 </table>
  68 <table cellspacing=5 cellpadding=0 border=0>
  69   <tr>
  70     <td>
  71       &nbsp;
  72     </td>
  73     <td>
  74
  75 <p>
  76
  77 <p>
  78 Definition at line <a class="el" href="users_8h-source.html#l00020">20</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
  79   </tr>
  80 </table>
  81 <a name="a5" doxytag="users.h::CC_DENY"></a><p>
  82 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  83   <tr>
  84     <td class="md">
  85       <table cellpadding="0" cellspacing="0" border="0">
  86         <tr>
  87           <td class="md" nowrap valign="top"> #define CC_DENY&nbsp;&nbsp;&nbsp;1
  88       </table>
  89     </td>
  90   </tr>
  91 </table>
  92 <table cellspacing=5 cellpadding=0 border=0>
  93   <tr>
  94     <td>
  95       &nbsp;
  96     </td>
  97     <td>
  98
  99 <p>
 100
 101 <p>
 102 Definition at line <a class="el" href="users_8h-source.html#l00021">21</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 103   </tr>
 104 </table>
 105 <a name="a1" doxytag="users.h::STATUS_HOP"></a><p>
 106 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 107   <tr>
 108     <td class="md">
 109       <table cellpadding="0" cellspacing="0" border="0">
 110         <tr>
 111           <td class="md" nowrap valign="top"> #define STATUS_HOP&nbsp;&nbsp;&nbsp;2
 112       </table>
 113     </td>
 114   </tr>
 115 </table>
 116 <table cellspacing=5 cellpadding=0 border=0>
 117   <tr>
 118     <td>
 119       &nbsp;
 120     </td>
 121     <td>
 122
 123 <p>
 124
 125 <p>
 126 Definition at line <a class="el" href="users_8h-source.html#l00016">16</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 127   </tr>
 128 </table>
 129 <a name="a3" doxytag="users.h::STATUS_NORMAL"></a><p>
 130 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 131   <tr>
 132     <td class="md">
 133       <table cellpadding="0" cellspacing="0" border="0">
 134         <tr>
 135           <td class="md" nowrap valign="top"> #define STATUS_NORMAL&nbsp;&nbsp;&nbsp;0
 136       </table>
 137     </td>
 138   </tr>
 139 </table>
 140 <table cellspacing=5 cellpadding=0 border=0>
 141   <tr>
 142     <td>
 143       &nbsp;
 144     </td>
 145     <td>
 146
 147 <p>
 148
 149 <p>
 150 Definition at line <a class="el" href="users_8h-source.html#l00018">18</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 151   </tr>
 152 </table>
 153 <a name="a0" doxytag="users.h::STATUS_OP"></a><p>
 154 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 155   <tr>
 156     <td class="md">
 157       <table cellpadding="0" cellspacing="0" border="0">
 158         <tr>
 159           <td class="md" nowrap valign="top"> #define STATUS_OP&nbsp;&nbsp;&nbsp;4
 160       </table>
 161     </td>
 162   </tr>
 163 </table>
 164 <table cellspacing=5 cellpadding=0 border=0>
 165   <tr>
 166     <td>
 167       &nbsp;
 168     </td>
 169     <td>
 170
 171 <p>
 172
 173 <p>
 174 Definition at line <a class="el" href="users_8h-source.html#l00015">15</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 175   </tr>
 176 </table>
 177 <a name="a2" doxytag="users.h::STATUS_VOICE"></a><p>
 178 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 179   <tr>
 180     <td class="md">
 181       <table cellpadding="0" cellspacing="0" border="0">
 182         <tr>
 183           <td class="md" nowrap valign="top"> #define STATUS_VOICE&nbsp;&nbsp;&nbsp;1
 184       </table>
 185     </td>
 186   </tr>
 187 </table>
 188 <table cellspacing=5 cellpadding=0 border=0>
 189   <tr>
 190     <td>
 191       &nbsp;
 192     </td>
 193     <td>
 194
 195 <p>
 196
 197 <p>
 198 Definition at line <a class="el" href="users_8h-source.html#l00017">17</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 199   </tr>
 200 </table>
 201 <hr><h2>Typedef Documentation</h2>
 202 <a name="a7" doxytag="users.h::ClassVector"></a><p>
 203 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 204   <tr>
 205     <td class="md">
 206       <table cellpadding="0" cellspacing="0" border="0">
 207         <tr>
 208           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classConnectClass.html">ConnectClass</a>&gt; ClassVector
 209       </table>
 210     </td>
 211   </tr>
 212 </table>
 213 <table cellspacing=5 cellpadding=0 border=0>
 214   <tr>
 215     <td>
 216       &nbsp;
 217     </td>
 218     <td>
 219
 220 <p>
 221 Holds a complete list of all allow and deny tags from the configuration file (connection classes).
 222 <p>
 223
 224 <p>
 225 Definition at line <a class="el" href="users_8h-source.html#l00070">70</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 226   </tr>
 227 </table>
 228 <a name="a6" doxytag="users.h::InvitedList"></a><p>
 229 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 230   <tr>
 231     <td class="md">
 232       <table cellpadding="0" cellspacing="0" border="0">
 233         <tr>
 234           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classInvited.html">Invited</a>&gt; InvitedList
 235       </table>
 236     </td>
 237   </tr>
 238 </table>
 239 <table cellspacing=5 cellpadding=0 border=0>
 240   <tr>
 241     <td>
 242       &nbsp;
 243     </td>
 244     <td>
 245
 246 <p>
 247 Holds a complete list of all channels to which a user has been invited and has not yet joined.
 248 <p>
 249
 250 <p>
 251 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>.    </td>
 252   </tr>
 253 </table>
 254 <hr><address style="align: right;"><small>Generated on Sat May 1 20:57:57 2004 for InspIRCd by
 255 <a href="http://www.doxygen.org/index.html">
 256 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 257 width=110 height=53></a>1.3-rc3 </small></address>
 258 </body>
 259 </html>