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>InspIRCd: users.h File Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   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">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>users.h File Reference</h1><code>#include "inspircd_config.h"</code><br>
   9 <code>#include "<a class="el" href="channels_8h-source.html">channels.h</a>"</code><br>
  10 <code>#include "<a class="el" href="connection_8h-source.html">connection.h</a>"</code><br>
  11 <code>#include "inspstring.h"</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="181,82,266,109" alt="">
  18 <area href="connection_8h.html" shape="rect" coords="58,82,157,109" 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="432,9,530,35" alt="">
  25 <area href="message_8h.html" shape="rect" coords="376,83,461,110" alt="">
  26 <area href="mode_8h.html" shape="rect" coords="485,83,552,110" alt="">
  27 <area href="xline_8h.html" shape="rect" coords="290,83,352,110" alt="">
  28 <area href="modules_8cpp.html" shape="rect" coords="272,9,370,35" alt="">
  29 <area href="commands_8h.html" shape="rect" coords="64,83,162,110" alt="">
  30 <area href="users_8cpp.html" shape="rect" coords="186,83,266,110" 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 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>
  38
  39 <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. </em> <a href="classConnectClass.html#_details">More...</a><em><br><br></td></tr>
  40 <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>
  41
  42 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Holds a channel name to which a user has been invited. </em> <a href="classInvited.html#_details">More...</a><em><br><br></td></tr>
  43 <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>
  44
  45 <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. </em> <a href="classuserrec.html#_details">More...</a><em><br><br></td></tr>
  46 <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>
  47
  48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A lightweight userrec used by WHOWAS. </em> <a href="classWhoWasUser.html#_details">More...</a><em><br><br></td></tr>
  49 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  50 <tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="users_8h.html#a0">STATUS_OP</a>&nbsp;&nbsp;&nbsp;4</td></tr>
  51
  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#a1">STATUS_HOP</a>&nbsp;&nbsp;&nbsp;2</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#a2">STATUS_VOICE</a>&nbsp;&nbsp;&nbsp;1</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#a3">STATUS_NORMAL</a>&nbsp;&nbsp;&nbsp;0</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#a4">CC_ALLOW</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#a5">CC_DENY</a>&nbsp;&nbsp;&nbsp;1</td></tr>
  61
  62 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  63 <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#a6">InvitedList</a></td></tr>
  64
  65 <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. </em> <a href="#a6"></a><em><br><br></td></tr>
  66 <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#a7">ClassVector</a></td></tr>
  67
  68 <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). </em> <a href="#a7"></a><em><br><br></td></tr>
  69 </table>
  70 <hr><h2>Define Documentation</h2>
  71 <a name="a4" doxytag="users.h::CC_ALLOW"></a><p>
  72 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  73   <tr>
  74     <td class="mdRow">
  75       <table cellpadding="0" cellspacing="0" border="0">
  76         <tr>
  77           <td class="md" nowrap valign="top"> #define CC_ALLOW&nbsp;&nbsp;&nbsp;0
  78       </table>
  79     </td>
  80   </tr>
  81 </table>
  82 <table cellspacing=5 cellpadding=0 border=0>
  83   <tr>
  84     <td>
  85       &nbsp;
  86     </td>
  87     <td>
  88
  89 <p>
  90
  91 <p>
  92 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>
  93   </tr>
  94 </table>
  95 <a name="a5" doxytag="users.h::CC_DENY"></a><p>
  96 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  97   <tr>
  98     <td class="mdRow">
  99       <table cellpadding="0" cellspacing="0" border="0">
 100         <tr>
 101           <td class="md" nowrap valign="top"> #define CC_DENY&nbsp;&nbsp;&nbsp;1
 102       </table>
 103     </td>
 104   </tr>
 105 </table>
 106 <table cellspacing=5 cellpadding=0 border=0>
 107   <tr>
 108     <td>
 109       &nbsp;
 110     </td>
 111     <td>
 112
 113 <p>
 114
 115 <p>
 116 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>
 117   </tr>
 118 </table>
 119 <a name="a1" doxytag="users.h::STATUS_HOP"></a><p>
 120 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 121   <tr>
 122     <td class="mdRow">
 123       <table cellpadding="0" cellspacing="0" border="0">
 124         <tr>
 125           <td class="md" nowrap valign="top"> #define STATUS_HOP&nbsp;&nbsp;&nbsp;2
 126       </table>
 127     </td>
 128   </tr>
 129 </table>
 130 <table cellspacing=5 cellpadding=0 border=0>
 131   <tr>
 132     <td>
 133       &nbsp;
 134     </td>
 135     <td>
 136
 137 <p>
 138
 139 <p>
 140 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>
 141   </tr>
 142 </table>
 143 <a name="a3" doxytag="users.h::STATUS_NORMAL"></a><p>
 144 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 145   <tr>
 146     <td class="mdRow">
 147       <table cellpadding="0" cellspacing="0" border="0">
 148         <tr>
 149           <td class="md" nowrap valign="top"> #define STATUS_NORMAL&nbsp;&nbsp;&nbsp;0
 150       </table>
 151     </td>
 152   </tr>
 153 </table>
 154 <table cellspacing=5 cellpadding=0 border=0>
 155   <tr>
 156     <td>
 157       &nbsp;
 158     </td>
 159     <td>
 160
 161 <p>
 162
 163 <p>
 164 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>
 165   </tr>
 166 </table>
 167 <a name="a0" doxytag="users.h::STATUS_OP"></a><p>
 168 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 169   <tr>
 170     <td class="mdRow">
 171       <table cellpadding="0" cellspacing="0" border="0">
 172         <tr>
 173           <td class="md" nowrap valign="top"> #define STATUS_OP&nbsp;&nbsp;&nbsp;4
 174       </table>
 175     </td>
 176   </tr>
 177 </table>
 178 <table cellspacing=5 cellpadding=0 border=0>
 179   <tr>
 180     <td>
 181       &nbsp;
 182     </td>
 183     <td>
 184
 185 <p>
 186
 187 <p>
 188 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>
 189   </tr>
 190 </table>
 191 <a name="a2" doxytag="users.h::STATUS_VOICE"></a><p>
 192 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 193   <tr>
 194     <td class="mdRow">
 195       <table cellpadding="0" cellspacing="0" border="0">
 196         <tr>
 197           <td class="md" nowrap valign="top"> #define STATUS_VOICE&nbsp;&nbsp;&nbsp;1
 198       </table>
 199     </td>
 200   </tr>
 201 </table>
 202 <table cellspacing=5 cellpadding=0 border=0>
 203   <tr>
 204     <td>
 205       &nbsp;
 206     </td>
 207     <td>
 208
 209 <p>
 210
 211 <p>
 212 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>
 213   </tr>
 214 </table>
 215 <hr><h2>Typedef Documentation</h2>
 216 <a name="a7" doxytag="users.h::ClassVector"></a><p>
 217 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 218   <tr>
 219     <td class="mdRow">
 220       <table cellpadding="0" cellspacing="0" border="0">
 221         <tr>
 222           <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#a7">ClassVector</a>
 223       </table>
 224     </td>
 225   </tr>
 226 </table>
 227 <table cellspacing=5 cellpadding=0 border=0>
 228   <tr>
 229     <td>
 230       &nbsp;
 231     </td>
 232     <td>
 233
 234 <p>
 235 Holds a complete list of all allow and deny tags from the configuration file (connection classes).
 236 <p>
 237
 238 <p>
 239 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>
 240   </tr>
 241 </table>
 242 <a name="a6" doxytag="users.h::InvitedList"></a><p>
 243 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 244   <tr>
 245     <td class="mdRow">
 246       <table cellpadding="0" cellspacing="0" border="0">
 247         <tr>
 248           <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#a6">InvitedList</a>
 249       </table>
 250     </td>
 251   </tr>
 252 </table>
 253 <table cellspacing=5 cellpadding=0 border=0>
 254   <tr>
 255     <td>
 256       &nbsp;
 257     </td>
 258     <td>
 259
 260 <p>
 261 Holds a complete list of all channels to which a user has been invited and has not yet joined.
 262 <p>
 263
 264 <p>
 265 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>
 266   </tr>
 267 </table>
 268 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:21 2005 for InspIRCd by
 269 <a href="http://www.doxygen.org/index.html">
 270 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 271 </a>1.3.3 </small></address>
 272 </body>
 273 </html>