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