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="doxygen.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="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="users_8cpp.html" shape="rect" coords="7,16,73,37" alt="">
  25 </map>
  26
  27 <p>
  28 <a href="users_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  29 <tr><td></td></tr>
  30 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  31 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classConnectClass.html">ConnectClass</a></td></tr>
  32 <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>
  33 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classInvited.html">Invited</a></td></tr>
  34 <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>
  35 <tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html">userrec</a></td></tr>
  36 <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>
  37 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  38 <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>
  39 <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>
  40 <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>
  41 <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>
  42 <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>
  43 <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>
  44 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  45 <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>
  46 <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>
  47 <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>
  48 <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>
  49 </table>
  50 <hr><h2>Define Documentation</h2>
  51 <a name="a4" doxytag="users.h::CC_ALLOW"></a><p>
  52 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  53   <tr>
  54     <td class="md">
  55       <table cellpadding="0" cellspacing="0" border="0">
  56         <tr>
  57           <td class="md" nowrap valign="top"> #define CC_ALLOW&nbsp;&nbsp;&nbsp;0
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <table cellspacing=5 cellpadding=0 border=0>
  63   <tr>
  64     <td>
  65       &nbsp;
  66     </td>
  67     <td>
  68
  69 <p>
  70
  71 <p>
  72 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>
  73   </tr>
  74 </table>
  75 <a name="a5" doxytag="users.h::CC_DENY"></a><p>
  76 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  77   <tr>
  78     <td class="md">
  79       <table cellpadding="0" cellspacing="0" border="0">
  80         <tr>
  81           <td class="md" nowrap valign="top"> #define CC_DENY&nbsp;&nbsp;&nbsp;1
  82       </table>
  83     </td>
  84   </tr>
  85 </table>
  86 <table cellspacing=5 cellpadding=0 border=0>
  87   <tr>
  88     <td>
  89       &nbsp;
  90     </td>
  91     <td>
  92
  93 <p>
  94
  95 <p>
  96 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>
  97   </tr>
  98 </table>
  99 <a name="a1" doxytag="users.h::STATUS_HOP"></a><p>
 100 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 101   <tr>
 102     <td class="md">
 103       <table cellpadding="0" cellspacing="0" border="0">
 104         <tr>
 105           <td class="md" nowrap valign="top"> #define STATUS_HOP&nbsp;&nbsp;&nbsp;2
 106       </table>
 107     </td>
 108   </tr>
 109 </table>
 110 <table cellspacing=5 cellpadding=0 border=0>
 111   <tr>
 112     <td>
 113       &nbsp;
 114     </td>
 115     <td>
 116
 117 <p>
 118
 119 <p>
 120 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>
 121   </tr>
 122 </table>
 123 <a name="a3" doxytag="users.h::STATUS_NORMAL"></a><p>
 124 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 125   <tr>
 126     <td class="md">
 127       <table cellpadding="0" cellspacing="0" border="0">
 128         <tr>
 129           <td class="md" nowrap valign="top"> #define STATUS_NORMAL&nbsp;&nbsp;&nbsp;0
 130       </table>
 131     </td>
 132   </tr>
 133 </table>
 134 <table cellspacing=5 cellpadding=0 border=0>
 135   <tr>
 136     <td>
 137       &nbsp;
 138     </td>
 139     <td>
 140
 141 <p>
 142
 143 <p>
 144 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>
 145   </tr>
 146 </table>
 147 <a name="a0" doxytag="users.h::STATUS_OP"></a><p>
 148 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 149   <tr>
 150     <td class="md">
 151       <table cellpadding="0" cellspacing="0" border="0">
 152         <tr>
 153           <td class="md" nowrap valign="top"> #define STATUS_OP&nbsp;&nbsp;&nbsp;4
 154       </table>
 155     </td>
 156   </tr>
 157 </table>
 158 <table cellspacing=5 cellpadding=0 border=0>
 159   <tr>
 160     <td>
 161       &nbsp;
 162     </td>
 163     <td>
 164
 165 <p>
 166
 167 <p>
 168 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>
 169   </tr>
 170 </table>
 171 <a name="a2" doxytag="users.h::STATUS_VOICE"></a><p>
 172 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 173   <tr>
 174     <td class="md">
 175       <table cellpadding="0" cellspacing="0" border="0">
 176         <tr>
 177           <td class="md" nowrap valign="top"> #define STATUS_VOICE&nbsp;&nbsp;&nbsp;1
 178       </table>
 179     </td>
 180   </tr>
 181 </table>
 182 <table cellspacing=5 cellpadding=0 border=0>
 183   <tr>
 184     <td>
 185       &nbsp;
 186     </td>
 187     <td>
 188
 189 <p>
 190
 191 <p>
 192 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>
 193   </tr>
 194 </table>
 195 <hr><h2>Typedef Documentation</h2>
 196 <a name="a7" doxytag="users.h::ClassVector"></a><p>
 197 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 198   <tr>
 199     <td class="md">
 200       <table cellpadding="0" cellspacing="0" border="0">
 201         <tr>
 202           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classConnectClass.html">ConnectClass</a>&gt; ClassVector
 203       </table>
 204     </td>
 205   </tr>
 206 </table>
 207 <table cellspacing=5 cellpadding=0 border=0>
 208   <tr>
 209     <td>
 210       &nbsp;
 211     </td>
 212     <td>
 213
 214 <p>
 215 Holds a complete list of all allow and deny tags from the configuration file (connection classes).
 216 <p>
 217
 218 <p>
 219 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>
 220   </tr>
 221 </table>
 222 <a name="a6" doxytag="users.h::InvitedList"></a><p>
 223 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 224   <tr>
 225     <td class="md">
 226       <table cellpadding="0" cellspacing="0" border="0">
 227         <tr>
 228           <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classInvited.html">Invited</a>&gt; InvitedList
 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 Holds a complete list of all channels to which a user has been invited and has not yet joined.
 242 <p>
 243
 244 <p>
 245 Definition at line <a class="el" href="users_8h-source.html#l00044">44</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 246   </tr>
 247 </table>
 248 <hr><address style="align: right;"><small>Generated on Fri Apr 2 14:46:10 2004 for InspIRCd by
 249 <a href="http://www.doxygen.org/index.html">
 250 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 251 width=110 height=53></a>1.3-rc3 </small></address>
 252 </body>
 253 </html>