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 <a href="users_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Compounds</h2></td></tr>
  18 <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>
  19
  20 <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>
  21 <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>
  22
  23 <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>
  24 <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>
  25
  26 <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>
  27 <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>
  28
  29 <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>
  30 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  31 <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>
  32
  33 <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>
  34
  35 <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>
  36
  37 <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>
  38
  39 <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>
  40
  41 <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>
  42
  43 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  44 <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>
  45
  46 <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>
  47 <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>
  48
  49 <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>
  50 </table>
  51 <hr><h2>Define Documentation</h2>
  52 <a name="a4" doxytag="users.h::CC_ALLOW"></a><p>
  53 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  54   <tr>
  55     <td class="mdRow">
  56       <table cellpadding="0" cellspacing="0" border="0">
  57         <tr>
  58           <td class="md" nowrap valign="top"> #define CC_ALLOW&nbsp;&nbsp;&nbsp;0
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <table cellspacing=5 cellpadding=0 border=0>
  64   <tr>
  65     <td>
  66       &nbsp;
  67     </td>
  68     <td>
  69
  70 <p>
  71
  72 <p>
  73 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>
  74   </tr>
  75 </table>
  76 <a name="a5" doxytag="users.h::CC_DENY"></a><p>
  77 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  78   <tr>
  79     <td class="mdRow">
  80       <table cellpadding="0" cellspacing="0" border="0">
  81         <tr>
  82           <td class="md" nowrap valign="top"> #define CC_DENY&nbsp;&nbsp;&nbsp;1
  83       </table>
  84     </td>
  85   </tr>
  86 </table>
  87 <table cellspacing=5 cellpadding=0 border=0>
  88   <tr>
  89     <td>
  90       &nbsp;
  91     </td>
  92     <td>
  93
  94 <p>
  95
  96 <p>
  97 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>
  98   </tr>
  99 </table>
 100 <a name="a1" doxytag="users.h::STATUS_HOP"></a><p>
 101 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 102   <tr>
 103     <td class="mdRow">
 104       <table cellpadding="0" cellspacing="0" border="0">
 105         <tr>
 106           <td class="md" nowrap valign="top"> #define STATUS_HOP&nbsp;&nbsp;&nbsp;2
 107       </table>
 108     </td>
 109   </tr>
 110 </table>
 111 <table cellspacing=5 cellpadding=0 border=0>
 112   <tr>
 113     <td>
 114       &nbsp;
 115     </td>
 116     <td>
 117
 118 <p>
 119
 120 <p>
 121 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>
 122   </tr>
 123 </table>
 124 <a name="a3" doxytag="users.h::STATUS_NORMAL"></a><p>
 125 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 126   <tr>
 127     <td class="mdRow">
 128       <table cellpadding="0" cellspacing="0" border="0">
 129         <tr>
 130           <td class="md" nowrap valign="top"> #define STATUS_NORMAL&nbsp;&nbsp;&nbsp;0
 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#l00029">29</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 146   </tr>
 147 </table>
 148 <a name="a0" doxytag="users.h::STATUS_OP"></a><p>
 149 <table class="mdTable" width="100%" 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_OP&nbsp;&nbsp;&nbsp;4
 155       </table>
 156     </td>
 157   </tr>
 158 </table>
 159 <table cellspacing=5 cellpadding=0 border=0>
 160   <tr>
 161     <td>
 162       &nbsp;
 163     </td>
 164     <td>
 165
 166 <p>
 167
 168 <p>
 169 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>
 170   </tr>
 171 </table>
 172 <a name="a2" doxytag="users.h::STATUS_VOICE"></a><p>
 173 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 174   <tr>
 175     <td class="mdRow">
 176       <table cellpadding="0" cellspacing="0" border="0">
 177         <tr>
 178           <td class="md" nowrap valign="top"> #define STATUS_VOICE&nbsp;&nbsp;&nbsp;1
 179       </table>
 180     </td>
 181   </tr>
 182 </table>
 183 <table cellspacing=5 cellpadding=0 border=0>
 184   <tr>
 185     <td>
 186       &nbsp;
 187     </td>
 188     <td>
 189
 190 <p>
 191
 192 <p>
 193 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>
 194   </tr>
 195 </table>
 196 <hr><h2>Typedef Documentation</h2>
 197 <a name="a7" doxytag="users.h::ClassVector"></a><p>
 198 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 199   <tr>
 200     <td class="mdRow">
 201       <table cellpadding="0" cellspacing="0" border="0">
 202         <tr>
 203           <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>
 204       </table>
 205     </td>
 206   </tr>
 207 </table>
 208 <table cellspacing=5 cellpadding=0 border=0>
 209   <tr>
 210     <td>
 211       &nbsp;
 212     </td>
 213     <td>
 214
 215 <p>
 216 Holds a complete list of all allow and deny tags from the configuration file (connection classes).
 217 <p>
 218
 219 <p>
 220 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>
 221   </tr>
 222 </table>
 223 <a name="a6" doxytag="users.h::InvitedList"></a><p>
 224 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 225   <tr>
 226     <td class="mdRow">
 227       <table cellpadding="0" cellspacing="0" border="0">
 228         <tr>
 229           <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>
 230       </table>
 231     </td>
 232   </tr>
 233 </table>
 234 <table cellspacing=5 cellpadding=0 border=0>
 235   <tr>
 236     <td>
 237       &nbsp;
 238     </td>
 239     <td>
 240
 241 <p>
 242 Holds a complete list of all channels to which a user has been invited and has not yet joined.
 243 <p>
 244
 245 <p>
 246 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>
 247   </tr>
 248 </table>
 249 <hr size="1"><address style="align: right;"><small>Generated on Thu May 12 22:59:00 2005 for InspIRCd by
 250 <a href="http://www.doxygen.org/index.html">
 251 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 252 </a>1.3.3 </small></address>
 253 </body>
 254 </html>