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