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="413,412,512,439" alt="">
  27 <area href="modules_8cpp-source.html" shape="rect" coords="413,311,512,337" alt="">
  28 <area href="users_8cpp-source.html" shape="rect" coords="280,159,360,185" alt="">
  29 <area href="commands_8h-source.html" shape="rect" coords="125,108,224,135" alt="">
  30 <area href="globals_8h-source.html" shape="rect" coords="137,361,212,388" alt="">
  31 <area href="typedefs_8h-source.html" shape="rect" coords="277,361,363,388" alt="">
  32 <area href="inspircd_8h-source.html" shape="rect" coords="135,209,215,236" alt="">
  33 <area href="cull__list_8h-source.html" shape="rect" coords="136,412,213,439" alt="">
  34 <area href="message_8h-source.html" shape="rect" coords="277,564,363,591" alt="">
  35 <area href="mode_8h-source.html" shape="rect" coords="287,260,353,287" alt="">
  36 <area href="userprocess_8h-source.html" shape="rect" coords="123,564,227,591" alt="">
  37 <area href="xline_8h-source.html" shape="rect" coords="289,463,351,489" alt="">
  38 </map>
  39
  40 <p>
  41 <a href="users_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  42 <tr><td></td></tr>
  43 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  44 <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>
  45
  46 <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>
  47 <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>
  48
  49 <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>
  50 <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>
  51
  52 <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>
  53 <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>
  54
  55 <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>
  56 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
  57 <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>
  58
  59 <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>
  60
  61 <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>
  62
  63 <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>
  64
  65 <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>
  66
  67 <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>
  68
  69 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
  70 <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>
  71
  72 <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>
  73 <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>
  74
  75 <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>
  76 </table>
  77 <hr><h2>Define Documentation</h2>
  78 <a class="anchor" name="CC_5FALLOW"></a><!-- doxytag: member="users.h::CC_ALLOW" ref="CC_5FALLOW" args="" --><p>
  79 <table class="mdTable" cellpadding="2" cellspacing="0">
  80   <tr>
  81     <td class="mdRow">
  82       <table cellpadding="0" cellspacing="0" border="0">
  83         <tr>
  84           <td class="md" nowrap valign="top">#define CC_ALLOW&nbsp;&nbsp;&nbsp;0          </td>
  85         </tr>
  86       </table>
  87     </td>
  88   </tr>
  89 </table>
  90 <table cellspacing="5" cellpadding="0" border="0">
  91   <tr>
  92     <td>
  93       &nbsp;
  94     </td>
  95     <td>
  96
  97 <p>
  98
  99 <p>
 100 Definition at line <a class="el" href="users_8h-source.html#l00034">34</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 101   </tr>
 102 </table>
 103 <a class="anchor" name="CC_5FDENY"></a><!-- doxytag: member="users.h::CC_DENY" ref="CC_5FDENY" args="" --><p>
 104 <table class="mdTable" cellpadding="2" cellspacing="0">
 105   <tr>
 106     <td class="mdRow">
 107       <table cellpadding="0" cellspacing="0" border="0">
 108         <tr>
 109           <td class="md" nowrap valign="top">#define CC_DENY&nbsp;&nbsp;&nbsp;1          </td>
 110         </tr>
 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#l00035">35</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 126   </tr>
 127 </table>
 128 <a class="anchor" name="STATUS_5FHOP"></a><!-- doxytag: member="users.h::STATUS_HOP" ref="STATUS_5FHOP" args="" --><p>
 129 <table class="mdTable" cellpadding="2" cellspacing="0">
 130   <tr>
 131     <td class="mdRow">
 132       <table cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td class="md" nowrap valign="top">#define STATUS_HOP&nbsp;&nbsp;&nbsp;2          </td>
 135         </tr>
 136       </table>
 137     </td>
 138   </tr>
 139 </table>
 140 <table cellspacing="5" cellpadding="0" border="0">
 141   <tr>
 142     <td>
 143       &nbsp;
 144     </td>
 145     <td>
 146
 147 <p>
 148
 149 <p>
 150 Definition at line <a class="el" href="users_8h-source.html#l00030">30</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 151 <p>
 152 Referenced by <a class="el" href="channels_8cpp-source.html#l00459">kick_channel()</a>.    </td>
 153   </tr>
 154 </table>
 155 <a class="anchor" name="STATUS_5FNORMAL"></a><!-- doxytag: member="users.h::STATUS_NORMAL" ref="STATUS_5FNORMAL" args="" --><p>
 156 <table class="mdTable" cellpadding="2" cellspacing="0">
 157   <tr>
 158     <td class="mdRow">
 159       <table cellpadding="0" cellspacing="0" border="0">
 160         <tr>
 161           <td class="md" nowrap valign="top">#define STATUS_NORMAL&nbsp;&nbsp;&nbsp;0          </td>
 162         </tr>
 163       </table>
 164     </td>
 165   </tr>
 166 </table>
 167 <table cellspacing="5" cellpadding="0" border="0">
 168   <tr>
 169     <td>
 170       &nbsp;
 171     </td>
 172     <td>
 173
 174 <p>
 175
 176 <p>
 177 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>
 178   </tr>
 179 </table>
 180 <a class="anchor" name="STATUS_5FOP"></a><!-- doxytag: member="users.h::STATUS_OP" ref="STATUS_5FOP" args="" --><p>
 181 <table class="mdTable" cellpadding="2" cellspacing="0">
 182   <tr>
 183     <td class="mdRow">
 184       <table cellpadding="0" cellspacing="0" border="0">
 185         <tr>
 186           <td class="md" nowrap valign="top">#define STATUS_OP&nbsp;&nbsp;&nbsp;4          </td>
 187         </tr>
 188       </table>
 189     </td>
 190   </tr>
 191 </table>
 192 <table cellspacing="5" cellpadding="0" border="0">
 193   <tr>
 194     <td>
 195       &nbsp;
 196     </td>
 197     <td>
 198
 199 <p>
 200
 201 <p>
 202 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>
 203   </tr>
 204 </table>
 205 <a class="anchor" name="STATUS_5FVOICE"></a><!-- doxytag: member="users.h::STATUS_VOICE" ref="STATUS_5FVOICE" args="" --><p>
 206 <table class="mdTable" cellpadding="2" cellspacing="0">
 207   <tr>
 208     <td class="mdRow">
 209       <table cellpadding="0" cellspacing="0" border="0">
 210         <tr>
 211           <td class="md" nowrap valign="top">#define STATUS_VOICE&nbsp;&nbsp;&nbsp;1          </td>
 212         </tr>
 213       </table>
 214     </td>
 215   </tr>
 216 </table>
 217 <table cellspacing="5" cellpadding="0" border="0">
 218   <tr>
 219     <td>
 220       &nbsp;
 221     </td>
 222     <td>
 223
 224 <p>
 225
 226 <p>
 227 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>
 228   </tr>
 229 </table>
 230 <hr><h2>Typedef Documentation</h2>
 231 <a class="anchor" name="ClassVector"></a><!-- doxytag: member="users.h::ClassVector" ref="ClassVector" args="" --><p>
 232 <table class="mdTable" cellpadding="2" cellspacing="0">
 233   <tr>
 234     <td class="mdRow">
 235       <table cellpadding="0" cellspacing="0" border="0">
 236         <tr>
 237           <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>
 238         </tr>
 239       </table>
 240     </td>
 241   </tr>
 242 </table>
 243 <table cellspacing="5" cellpadding="0" border="0">
 244   <tr>
 245     <td>
 246       &nbsp;
 247     </td>
 248     <td>
 249
 250 <p>
 251 Holds a complete list of all allow and deny tags from the configuration file (connection classes).
 252 <p>
 253
 254 <p>
 255 Definition at line <a class="el" href="users_8h-source.html#l00103">103</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 256   </tr>
 257 </table>
 258 <a class="anchor" name="InvitedList"></a><!-- doxytag: member="users.h::InvitedList" ref="InvitedList" args="" --><p>
 259 <table class="mdTable" cellpadding="2" cellspacing="0">
 260   <tr>
 261     <td class="mdRow">
 262       <table cellpadding="0" cellspacing="0" border="0">
 263         <tr>
 264           <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>
 265         </tr>
 266       </table>
 267     </td>
 268   </tr>
 269 </table>
 270 <table cellspacing="5" cellpadding="0" border="0">
 271   <tr>
 272     <td>
 273       &nbsp;
 274     </td>
 275     <td>
 276
 277 <p>
 278 Holds a complete list of all channels to which a user has been invited and has not yet joined.
 279 <p>
 280
 281 <p>
 282 Definition at line <a class="el" href="users_8h-source.html#l00097">97</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 283   </tr>
 284 </table>
 285 <hr size="1"><address style="align: right;"><small>Generated on Thu Dec 15 11:14:17 2005 for InspIRCd by&nbsp;
 286 <a href="http://www.doxygen.org/index.html">
 287 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 288 </body>
 289 </html>