docs/module-doc/users_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: users.h File Reference</title>
   4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   7 <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">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <div class="nav">
   9 <a class="el" href="dir_000000.html">home</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">brain</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000002.html">inspircd-cvs</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000003.html">inspircd</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000004.html">include</a></div>
  10 <h1>users.h File Reference</h1><code>#include &quot;inspircd_config.h&quot;</code><br>
  11 <code>#include &quot;<a class="el" href="channels_8h-source.html">channels.h</a>&quot;</code><br>
  12 <code>#include &quot;inspstring.h&quot;</code><br>
  13 <code>#include &quot;<a class="el" href="connection_8h-source.html">connection.h</a>&quot;</code><br>
  14 <code>#include &lt;string&gt;</code><br>
  15
  16 <p>
  17 Include dependency graph for users.h:<p><center><img src="users_8h__incl.gif" border="0" usemap="#users.h_map" alt=""></center>
  18 <map name="users.h_map">
  19 <area href="channels_8h-source.html" shape="rect" coords="128,108,213,135" alt="">
  20 <area href="connection_8h-source.html" shape="rect" coords="121,58,220,84" alt="">
  21 </map>
  22
  23 <p>
  24 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=""></center>
  25 <map name="users.hdep_map">
  26 <area href="channels_8cpp-source.html" shape="rect" coords="269,83,368,109" alt="">
  27 <area href="modules_8cpp-source.html" shape="rect" coords="269,159,368,185" alt="">
  28 <area href="users_8cpp-source.html" shape="rect" coords="131,311,211,337" alt="">
  29 <area href="commands_8h-source.html" shape="rect" coords="121,209,220,236" alt="">
  30 <area href="message_8h-source.html" shape="rect" coords="128,57,213,84" alt="">
  31 <area href="mode_8h-source.html" shape="rect" coords="137,108,204,135" alt="">
  32 <area href="xline_8h-source.html" shape="rect" coords="140,159,201,185" alt="">
  33 </map>
  34
  35 <p>
  36 <a href="users_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  37 <tr><td></td></tr>
  38 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInvited.html">Invited</a></td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a channel name to which a user has been invited.  <a href="classInvited.html#_details">More...</a><br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classConnectClass.html">ConnectClass</a></td></tr>
  43
  44 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.  <a href="classConnectClass.html#_details">More...</a><br></td></tr>
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classuserrec.html">userrec</a></td></tr>
  46
  47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds all information about a user This class stores all information about a user connected to the irc server.  <a href="classuserrec.html#_details">More...</a><br></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWhoWasUser.html">WhoWasUser</a></td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A lightweight userrec used by WHOWAS.  <a href="classWhoWasUser.html#_details">More...</a><br></td></tr>
  51 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
  52 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FOP">STATUS_OP</a>&nbsp;&nbsp;&nbsp;4</td></tr>
  53
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FHOP">STATUS_HOP</a>&nbsp;&nbsp;&nbsp;2</td></tr>
  55
  56 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FVOICE">STATUS_VOICE</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  57
  58 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#STATUS_5FNORMAL">STATUS_NORMAL</a>&nbsp;&nbsp;&nbsp;0</td></tr>
  59
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#CC_5FALLOW">CC_ALLOW</a>&nbsp;&nbsp;&nbsp;0</td></tr>
  61
  62 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#CC_5FDENY">CC_DENY</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  63
  64 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="classInvited.html">Invited</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#InvitedList">InvitedList</a></td></tr>
  66
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete list of all channels to which a user has been invited and has not yet joined.  <a href="#InvitedList"></a><br></td></tr>
  68 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector&lt; <a class="el" href="classConnectClass.html">ConnectClass</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="users_8h.html#ClassVector">ClassVector</a></td></tr>
  69
  70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a complete list of all allow and deny tags from the configuration file (connection classes).  <a href="#ClassVector"></a><br></td></tr>
  71 </table>
  72 <hr><h2>Define Documentation</h2>
  73 <a class="anchor" name="CC_5FALLOW"></a><!-- doxytag: member="users.h::CC_ALLOW" ref="CC_5FALLOW" args="" --><p>
  74 <table class="mdTable" cellpadding="2" cellspacing="0">
  75   <tr>
  76     <td class="mdRow">
  77       <table cellpadding="0" cellspacing="0" border="0">
  78         <tr>
  79           <td class="md" nowrap valign="top">#define CC_ALLOW&nbsp;&nbsp;&nbsp;0          </td>
  80         </tr>
  81       </table>
  82     </td>
  83   </tr>
  84 </table>
  85 <table cellspacing="5" cellpadding="0" border="0">
  86   <tr>
  87     <td>
  88       &nbsp;
  89     </td>
  90     <td>
  91
  92 <p>
  93
  94 <p>
  95 Definition at line <a class="el" href="users_8h-source.html#l00031">31</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
  96   </tr>
  97 </table>
  98 <a class="anchor" name="CC_5FDENY"></a><!-- doxytag: member="users.h::CC_DENY" ref="CC_5FDENY" args="" --><p>
  99 <table class="mdTable" cellpadding="2" cellspacing="0">
 100   <tr>
 101     <td class="mdRow">
 102       <table cellpadding="0" cellspacing="0" border="0">
 103         <tr>
 104           <td class="md" nowrap valign="top">#define CC_DENY&nbsp;&nbsp;&nbsp;1          </td>
 105         </tr>
 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#l00032">32</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 121   </tr>
 122 </table>
 123 <a class="anchor" name="STATUS_5FHOP"></a><!-- doxytag: member="users.h::STATUS_HOP" ref="STATUS_5FHOP" args="" --><p>
 124 <table class="mdTable" cellpadding="2" cellspacing="0">
 125   <tr>
 126     <td class="mdRow">
 127       <table cellpadding="0" cellspacing="0" border="0">
 128         <tr>
 129           <td class="md" nowrap valign="top">#define STATUS_HOP&nbsp;&nbsp;&nbsp;2          </td>
 130         </tr>
 131       </table>
 132     </td>
 133   </tr>
 134 </table>
 135 <table cellspacing="5" cellpadding="0" border="0">
 136   <tr>
 137     <td>
 138       &nbsp;
 139     </td>
 140     <td>
 141
 142 <p>
 143
 144 <p>
 145 Definition at line <a class="el" href="users_8h-source.html#l00027">27</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 146   </tr>
 147 </table>
 148 <a class="anchor" name="STATUS_5FNORMAL"></a><!-- doxytag: member="users.h::STATUS_NORMAL" ref="STATUS_5FNORMAL" args="" --><p>
 149 <table class="mdTable" cellpadding="2" cellspacing="0">
 150   <tr>
 151     <td class="mdRow">
 152       <table cellpadding="0" cellspacing="0" border="0">
 153         <tr>
 154           <td class="md" nowrap valign="top">#define STATUS_NORMAL&nbsp;&nbsp;&nbsp;0          </td>
 155         </tr>
 156       </table>
 157     </td>
 158   </tr>
 159 </table>
 160 <table cellspacing="5" cellpadding="0" border="0">
 161   <tr>
 162     <td>
 163       &nbsp;
 164     </td>
 165     <td>
 166
 167 <p>
 168
 169 <p>
 170 Definition at line <a class="el" href="users_8h-source.html#l00029">29</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 171   </tr>
 172 </table>
 173 <a class="anchor" name="STATUS_5FOP"></a><!-- doxytag: member="users.h::STATUS_OP" ref="STATUS_5FOP" args="" --><p>
 174 <table class="mdTable" cellpadding="2" cellspacing="0">
 175   <tr>
 176     <td class="mdRow">
 177       <table cellpadding="0" cellspacing="0" border="0">
 178         <tr>
 179           <td class="md" nowrap valign="top">#define STATUS_OP&nbsp;&nbsp;&nbsp;4          </td>
 180         </tr>
 181       </table>
 182     </td>
 183   </tr>
 184 </table>
 185 <table cellspacing="5" cellpadding="0" border="0">
 186   <tr>
 187     <td>
 188       &nbsp;
 189     </td>
 190     <td>
 191
 192 <p>
 193
 194 <p>
 195 Definition at line <a class="el" href="users_8h-source.html#l00026">26</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 196   </tr>
 197 </table>
 198 <a class="anchor" name="STATUS_5FVOICE"></a><!-- doxytag: member="users.h::STATUS_VOICE" ref="STATUS_5FVOICE" args="" --><p>
 199 <table class="mdTable" cellpadding="2" cellspacing="0">
 200   <tr>
 201     <td class="mdRow">
 202       <table cellpadding="0" cellspacing="0" border="0">
 203         <tr>
 204           <td class="md" nowrap valign="top">#define STATUS_VOICE&nbsp;&nbsp;&nbsp;1          </td>
 205         </tr>
 206       </table>
 207     </td>
 208   </tr>
 209 </table>
 210 <table cellspacing="5" cellpadding="0" border="0">
 211   <tr>
 212     <td>
 213       &nbsp;
 214     </td>
 215     <td>
 216
 217 <p>
 218
 219 <p>
 220 Definition at line <a class="el" href="users_8h-source.html#l00028">28</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 221   </tr>
 222 </table>
 223 <hr><h2>Typedef Documentation</h2>
 224 <a class="anchor" name="ClassVector"></a><!-- doxytag: member="users.h::ClassVector" ref="ClassVector" args="" --><p>
 225 <table class="mdTable" cellpadding="2" cellspacing="0">
 226   <tr>
 227     <td class="mdRow">
 228       <table cellpadding="0" cellspacing="0" border="0">
 229         <tr>
 230           <td class="md" nowrap valign="top">typedef std::vector&lt;<a class="el" href="classConnectClass.html">ConnectClass</a>&gt; <a class="el" href="users_8h.html#ClassVector">ClassVector</a>          </td>
 231         </tr>
 232       </table>
 233     </td>
 234   </tr>
 235 </table>
 236 <table cellspacing="5" cellpadding="0" border="0">
 237   <tr>
 238     <td>
 239       &nbsp;
 240     </td>
 241     <td>
 242
 243 <p>
 244 Holds a complete list of all allow and deny tags from the configuration file (connection classes).
 245 <p>
 246
 247 <p>
 248 Definition at line <a class="el" href="users_8h-source.html#l00100">100</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 249   </tr>
 250 </table>
 251 <a class="anchor" name="InvitedList"></a><!-- doxytag: member="users.h::InvitedList" ref="InvitedList" args="" --><p>
 252 <table class="mdTable" cellpadding="2" cellspacing="0">
 253   <tr>
 254     <td class="mdRow">
 255       <table cellpadding="0" cellspacing="0" border="0">
 256         <tr>
 257           <td class="md" nowrap valign="top">typedef std::vector&lt;<a class="el" href="classInvited.html">Invited</a>&gt; <a class="el" href="users_8h.html#InvitedList">InvitedList</a>          </td>
 258         </tr>
 259       </table>
 260     </td>
 261   </tr>
 262 </table>
 263 <table cellspacing="5" cellpadding="0" border="0">
 264   <tr>
 265     <td>
 266       &nbsp;
 267     </td>
 268     <td>
 269
 270 <p>
 271 Holds a complete list of all channels to which a user has been invited and has not yet joined.
 272 <p>
 273
 274 <p>
 275 Definition at line <a class="el" href="users_8h-source.html#l00094">94</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 276   </tr>
 277 </table>
 278 <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:24 2005 for InspIRCd by&nbsp;
 279 <a href="http://www.doxygen.org/index.html">
 280 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 281 </body>
 282 </html>