docs/module-doc/classuserrec.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>userrec class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc3 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
   9 <hr><h1>userrec Class Reference</h1>Holds all information about a user This class stores all information about a user connected to the irc server.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="users_8h-source.html">users.h</a>&gt;</code>
  13 <p>
  14 Inheritance diagram for userrec:<p><center><img src="classuserrec__inherit__graph.gif" border="0" usemap="#userrec__inherit__map" alt="Inheritance graph"></center>
  15 <map name="userrec__inherit__map">
  16 <area href="classconnection.html" shape="rect" coords="7,155,76,176" alt="">
  17 <area href="classExtensible.html" shape="rect" coords="7,86,76,107" alt="">
  18 <area href="classclassbase.html" shape="rect" coords="8,16,75,38" alt="">
  19 </map>
  20 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for userrec:<p><center><img src="classuserrec__coll__graph.gif" border="0" usemap="#userrec__coll__map" alt="Collaboration graph"></center>
  21 <map name="userrec__coll__map">
  22 <area href="classconnection.html" shape="rect" coords="204,352,273,373" alt="">
  23 <area href="classucrec.html" shape="rect" coords="216,611,261,632" alt="">
  24 </map>
  25 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classuserrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  26 <tr><td></td></tr>
  27 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  28 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a0">userrec</a> ()</td></tr>
  29 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a1">~userrec</a> ()</td></tr>
  30 <tr><td nowrap align=right valign=top>virtual char *&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a2">GetFullHost</a> ()</td></tr>
  31 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
  32 <tr><td nowrap align=right valign=top>virtual char *&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a3">GetFullRealHost</a> ()</td></tr>
  33 <tr><td>&nbsp;</td><td><font size=-1><em>Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
  34 <tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a4">IsInvited</a> (char *channel)</td></tr>
  35 <tr><td>&nbsp;</td><td><font size=-1><em>Returns true if a user is invited to a channel.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
  36 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a5">InviteTo</a> (char *channel)</td></tr>
  37 <tr><td>&nbsp;</td><td><font size=-1><em>Adds a channel to a users invite list (invites them to a channel).</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
  38 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#a6">RemoveInvite</a> (char *channel)</td></tr>
  39 <tr><td>&nbsp;</td><td><font size=-1><em>Removes a channel from a users invite list.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
  40 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  41 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m0">nick</a> [NICKMAX]</td></tr>
  42 <tr><td>&nbsp;</td><td><font size=-1><em>The users nickname.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
  43 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m1">ident</a> [64]</td></tr>
  44 <tr><td>&nbsp;</td><td><font size=-1><em>The users ident reply.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
  45 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m2">dhost</a> [256]</td></tr>
  46 <tr><td>&nbsp;</td><td><font size=-1><em>The host displayed to non-opers (used for cloaking etc).</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
  47 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m3">fullname</a> [128]</td></tr>
  48 <tr><td>&nbsp;</td><td><font size=-1><em>The users full name.</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
  49 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m4">modes</a> [MAXBUF]</td></tr>
  50 <tr><td>&nbsp;</td><td><font size=-1><em>The user's mode string.</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
  51 <tr><td nowrap align=right valign=top><a class="el" href="classucrec.html">ucrec</a>&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m5">chans</a> [MAXCHANS]</td></tr>
  52 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m6">server</a> [256]</td></tr>
  53 <tr><td>&nbsp;</td><td><font size=-1><em>The server the user is connected to.</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
  54 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m7">awaymsg</a> [512]</td></tr>
  55 <tr><td>&nbsp;</td><td><font size=-1><em>The user's away message.</em> <a href="#m7"></a><em></em></font><br><br></td></tr>
  56 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m8">result</a> [256]</td></tr>
  57 <tr><td>&nbsp;</td><td><font size=-1><em>Stores the result of the last GetFullHost or GetRealHost call.</em> <a href="#m8"></a><em></em></font><br><br></td></tr>
  58 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m9">flood</a></td></tr>
  59 <tr><td>&nbsp;</td><td><font size=-1><em>Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.</em> <a href="#m9"></a><em></em></font><br><br></td></tr>
  60 <tr><td nowrap align=right valign=top>unsigned long&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#m10">timeout</a></td></tr>
  61 <tr><td>&nbsp;</td><td><font size=-1><em>Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.</em> <a href="#m10"></a><em></em></font><br><br></td></tr>
  62 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
  63 <tr><td nowrap align=right valign=top><a class="el" href="users_8h.html#a6">InvitedList</a>&nbsp;</td><td valign=bottom><a class="el" href="classuserrec.html#o0">invites</a></td></tr>
  64 <tr><td>&nbsp;</td><td><font size=-1><em>A list of channels the user has a pending invite to.</em> <a href="#o0"></a><em></em></font><br><br></td></tr>
  65 </table>
  66 <hr><a name="_details"></a><h2>Detailed Description</h2>
  67 Holds all information about a user This class stores all information about a user connected to the irc server.
  68 <p>
  69 Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname.
  70 <p>
  71
  72 <p>
  73 Definition at line <a class="el" href="users_8h-source.html#l00078">78</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  74 <a name="a0" doxytag="userrec::userrec"></a><p>
  75 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  76   <tr>
  77     <td class="md">
  78       <table cellpadding="0" cellspacing="0" border="0">
  79         <tr>
  80           <td class="md" nowrap valign="top"> userrec::userrec </td>
  81           <td class="md" valign="top">(&nbsp;</td>
  82           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  83           <td class="md" valign="top">)&nbsp;</td>
  84           <td class="md" nowrap></td>
  85         </tr>
  86
  87       </table>
  88     </td>
  89   </tr>
  90 </table>
  91 <table cellspacing=5 cellpadding=0 border=0>
  92   <tr>
  93     <td>
  94       &nbsp;
  95     </td>
  96     <td>
  97
  98 <p>
  99
 100 <p>
 101 Definition at line <a class="el" href="users_8cpp-source.html#l00011">11</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
 102 <p>
 103 References <a class="el" href="connection_8h-source.html#l00182">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00186">connection::bytes_out</a>, <a class="el" href="channels_8h-source.html#l00202">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00112">chans</a>, <a class="el" href="connection_8h-source.html#l00190">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00194">connection::cmds_out</a>, <a class="el" href="connection_8h-source.html#l00166">connection::fd</a>, <a class="el" href="users_8h-source.html#l00132">flood</a>, <a class="el" href="connection_8h-source.html#l00198">connection::haspassed</a>, <a class="el" href="connection_8h-source.html#l00224">connection::idle_lastmsg</a>, <a class="el" href="users_8h-source.html#l00084">invites</a>, <a class="el" href="connection_8h-source.html#l00216">connection::lastping</a>, <a class="el" href="connection_8h-source.html#l00228">connection::nping</a>, <a class="el" href="connection_8h-source.html#l00204">connection::port</a>, <a class="el" href="connection_8h-source.html#l00208">connection::registered</a>, <a class="el" href="connection_8h-source.html#l00220">connection::signon</a>, <a class="el" href="users_8h-source.html#l00138">timeout</a>, and <a class="el" href="channels_8h-source.html#l00197">ucrec::uc_modes</a>.
 104 <p>
 105 <div class="fragment"><pre>00012 {
 106 00013         <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span>
 107 00014         strcpy(nick,<span class="stringliteral">""</span>);
 108 00015         strcpy(ip,<span class="stringliteral">"127.0.0.1"</span>);
 109 00016         <a class="code" href="classuserrec.html#m10">timeout</a> = 0;
 110 00017         strcpy(ident,<span class="stringliteral">""</span>);
 111 00018         strcpy(host,<span class="stringliteral">""</span>);
 112 00019         strcpy(dhost,<span class="stringliteral">""</span>);
 113 00020         strcpy(fullname,<span class="stringliteral">""</span>);
 114 00021         strcpy(modes,<span class="stringliteral">""</span>);
 115 00022         strcpy(inbuf,<span class="stringliteral">""</span>);
 116 00023         strcpy(server,<span class="stringliteral">""</span>);
 117 00024         strcpy(awaymsg,<span class="stringliteral">""</span>);
 118 00025         <a class="code" href="classconnection.html#m0">fd</a> = <a class="code" href="classconnection.html#m12">lastping</a> = <a class="code" href="classconnection.html#m13">signon</a> = <a class="code" href="classconnection.html#m14">idle_lastmsg</a> = <a class="code" href="classconnection.html#m15">nping</a> = <a class="code" href="classconnection.html#m10">registered</a> = 0;
 119 00026         <a class="code" href="classuserrec.html#m9">flood</a> = <a class="code" href="classconnection.html#m9">port</a> = <a class="code" href="classconnection.html#m4">bytes_in</a> = <a class="code" href="classconnection.html#m5">bytes_out</a> = <a class="code" href="classconnection.html#m6">cmds_in</a> = <a class="code" href="classconnection.html#m7">cmds_out</a> = 0;
 120 00027         <a class="code" href="classconnection.html#m8">haspassed</a> = <span class="keyword">false</span>;
 121 00028         strcpy(result,<span class="stringliteral">""</span>);
 122 00029         <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; MAXCHANS; i++)
 123 00030         {
 124 00031                 this-&gt;<a class="code" href="classuserrec.html#m5">chans</a>[i].<a class="code" href="classucrec.html#m1">channel</a> = NULL;
 125 00032                 this-&gt;<a class="code" href="classuserrec.html#m5">chans</a>[i].<a class="code" href="classucrec.html#m0">uc_modes</a> = 0;
 126 00033         }
 127 00034         <a class="code" href="classuserrec.html#o0">invites</a>.clear();
 128 00035 }
 129 </pre></div>    </td>
 130   </tr>
 131 </table>
 132 <a name="a1" doxytag="userrec::~userrec"></a><p>
 133 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 134   <tr>
 135     <td class="md">
 136       <table cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td class="md" nowrap valign="top"> virtual userrec::~userrec </td>
 139           <td class="md" valign="top">(&nbsp;</td>
 140           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 141           <td class="md" valign="top">)&nbsp;</td>
 142           <td class="md" nowrap><code> [inline, virtual]</code></td>
 143         </tr>
 144
 145       </table>
 146     </td>
 147   </tr>
 148 </table>
 149 <table cellspacing=5 cellpadding=0 border=0>
 150   <tr>
 151     <td>
 152       &nbsp;
 153     </td>
 154     <td>
 155
 156 <p>
 157
 158 <p>
 159 Definition at line <a class="el" href="users_8h-source.html#l00142">142</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 160 <p>
 161 <div class="fragment"><pre>00142 {  }
 162 </pre></div>    </td>
 163   </tr>
 164 </table>
 165 <hr><h2>Member Function Documentation</h2>
 166 <a name="a2" doxytag="userrec::GetFullHost"></a><p>
 167 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 168   <tr>
 169     <td class="md">
 170       <table cellpadding="0" cellspacing="0" border="0">
 171         <tr>
 172           <td class="md" nowrap valign="top"> char * userrec::GetFullHost </td>
 173           <td class="md" valign="top">(&nbsp;</td>
 174           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 175           <td class="md" valign="top">)&nbsp;</td>
 176           <td class="md" nowrap><code> [virtual]</code></td>
 177         </tr>
 178
 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 Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.
 192 <p>
 193
 194 <p>
 195 Definition at line <a class="el" href="users_8cpp-source.html#l00039">39</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
 196 <p>
 197 References <a class="el" href="users_8h-source.html#l00126">result</a>.
 198 <p>
 199 <div class="fragment"><pre>00040 {
 200 00041         sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost);
 201 00042         <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>;
 202 00043 }
 203 </pre></div>    </td>
 204   </tr>
 205 </table>
 206 <a name="a3" doxytag="userrec::GetFullRealHost"></a><p>
 207 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 208   <tr>
 209     <td class="md">
 210       <table cellpadding="0" cellspacing="0" border="0">
 211         <tr>
 212           <td class="md" nowrap valign="top"> char * userrec::GetFullRealHost </td>
 213           <td class="md" valign="top">(&nbsp;</td>
 214           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 215           <td class="md" valign="top">)&nbsp;</td>
 216           <td class="md" nowrap><code> [virtual]</code></td>
 217         </tr>
 218
 219       </table>
 220     </td>
 221   </tr>
 222 </table>
 223 <table cellspacing=5 cellpadding=0 border=0>
 224   <tr>
 225     <td>
 226       &nbsp;
 227     </td>
 228     <td>
 229
 230 <p>
 231 Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.
 232 <p>
 233 If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.
 234 <p>
 235 Definition at line <a class="el" href="users_8cpp-source.html#l00046">46</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
 236 <p>
 237 References <a class="el" href="users_8h-source.html#l00126">result</a>.
 238 <p>
 239 <div class="fragment"><pre>00047 {
 240 00048         sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host);
 241 00049         <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>;
 242 00050 }
 243 </pre></div>    </td>
 244   </tr>
 245 </table>
 246 <a name="a5" doxytag="userrec::InviteTo"></a><p>
 247 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 248   <tr>
 249     <td class="md">
 250       <table cellpadding="0" cellspacing="0" border="0">
 251         <tr>
 252           <td class="md" nowrap valign="top"> void userrec::InviteTo </td>
 253           <td class="md" valign="top">(&nbsp;</td>
 254           <td class="md" nowrap valign="top">char *&nbsp;</td>
 255           <td class="mdname1" valign="top" nowrap>&nbsp; <em>channel</em>          </td>
 256           <td class="md" valign="top">)&nbsp;</td>
 257           <td class="md" nowrap><code> [virtual]</code></td>
 258         </tr>
 259
 260       </table>
 261     </td>
 262   </tr>
 263 </table>
 264 <table cellspacing=5 cellpadding=0 border=0>
 265   <tr>
 266     <td>
 267       &nbsp;
 268     </td>
 269     <td>
 270
 271 <p>
 272 Adds a channel to a users invite list (invites them to a channel).
 273 <p>
 274
 275 <p>
 276 Definition at line <a class="el" href="users_8cpp-source.html#l00066">66</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
 277 <p>
 278 References <a class="el" href="users_8h-source.html#l00028">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00084">invites</a>.
 279 <p>
 280 <div class="fragment"><pre>00067 {
 281 00068         <a class="code" href="classInvited.html">Invited</a> i;
 282 00069         strcpy(i.<a class="code" href="classInvited.html#m0">channel</a>,channel);
 283 00070         <a class="code" href="classuserrec.html#o0">invites</a>.push_back(i);
 284 00071 }
 285 </pre></div>    </td>
 286   </tr>
 287 </table>
 288 <a name="a4" doxytag="userrec::IsInvited"></a><p>
 289 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 290   <tr>
 291     <td class="md">
 292       <table cellpadding="0" cellspacing="0" border="0">
 293         <tr>
 294           <td class="md" nowrap valign="top"> bool userrec::IsInvited </td>
 295           <td class="md" valign="top">(&nbsp;</td>
 296           <td class="md" nowrap valign="top">char *&nbsp;</td>
 297           <td class="mdname1" valign="top" nowrap>&nbsp; <em>channel</em>          </td>
 298           <td class="md" valign="top">)&nbsp;</td>
 299           <td class="md" nowrap><code> [virtual]</code></td>
 300         </tr>
 301
 302       </table>
 303     </td>
 304   </tr>
 305 </table>
 306 <table cellspacing=5 cellpadding=0 border=0>
 307   <tr>
 308     <td>
 309       &nbsp;
 310     </td>
 311     <td>
 312
 313 <p>
 314 Returns true if a user is invited to a channel.
 315 <p>
 316
 317 <p>
 318 Definition at line <a class="el" href="users_8cpp-source.html#l00052">52</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
 319 <p>
 320 References <a class="el" href="users_8h-source.html#l00084">invites</a>.
 321 <p>
 322 <div class="fragment"><pre>00053 {
 323 00054         <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#o0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#o0">invites</a>.end(); i++)
 324 00055         {
 325 00056                 <span class="keywordflow">if</span> (i-&gt;channel) {
 326 00057                         <span class="keywordflow">if</span> (!strcasecmp(i-&gt;channel,channel))
 327 00058                         {
 328 00059                                 <span class="keywordflow">return</span> <span class="keyword">true</span>;
 329 00060                         }
 330 00061                 }
 331 00062         }
 332 00063         <span class="keywordflow">return</span> <span class="keyword">false</span>;
 333 00064 }
 334 </pre></div>    </td>
 335   </tr>
 336 </table>
 337 <a name="a6" doxytag="userrec::RemoveInvite"></a><p>
 338 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 339   <tr>
 340     <td class="md">
 341       <table cellpadding="0" cellspacing="0" border="0">
 342         <tr>
 343           <td class="md" nowrap valign="top"> void userrec::RemoveInvite </td>
 344           <td class="md" valign="top">(&nbsp;</td>
 345           <td class="md" nowrap valign="top">char *&nbsp;</td>
 346           <td class="mdname1" valign="top" nowrap>&nbsp; <em>channel</em>          </td>
 347           <td class="md" valign="top">)&nbsp;</td>
 348           <td class="md" nowrap><code> [virtual]</code></td>
 349         </tr>
 350
 351       </table>
 352     </td>
 353   </tr>
 354 </table>
 355 <table cellspacing=5 cellpadding=0 border=0>
 356   <tr>
 357     <td>
 358       &nbsp;
 359     </td>
 360     <td>
 361
 362 <p>
 363 Removes a channel from a users invite list.
 364 <p>
 365 This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
 366 <p>
 367 Definition at line <a class="el" href="users_8cpp-source.html#l00073">73</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
 368 <p>
 369 References <a class="el" href="users_8h-source.html#l00084">invites</a>.
 370 <p>
 371 <div class="fragment"><pre>00074 {
 372 00075         log(DEBUG,<span class="stringliteral">"Removing invites"</span>);
 373 00076         <span class="keywordflow">if</span> (channel)
 374 00077         {
 375 00078                 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o0">invites</a>.size())
 376 00079                 {
 377 00080                         <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#o0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#o0">invites</a>.end(); i++)
 378 00081                         {
 379 00082                                 <span class="keywordflow">if</span> (i-&gt;channel)
 380 00083                                 {
 381 00084                                         <span class="keywordflow">if</span> (!strcasecmp(i-&gt;channel,channel))
 382 00085                                         {
 383 00086                                                 <a class="code" href="classuserrec.html#o0">invites</a>.erase(i);
 384 00087                                                 <span class="keywordflow">return</span>;
 385 00088                                         }
 386 00089                                 }
 387 00090                         }
 388 00091                 }
 389 00092         }
 390 00093 }
 391 </pre></div>    </td>
 392   </tr>
 393 </table>
 394 <hr><h2>Member Data Documentation</h2>
 395 <a name="m7" doxytag="userrec::awaymsg"></a><p>
 396 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 397   <tr>
 398     <td class="md">
 399       <table cellpadding="0" cellspacing="0" border="0">
 400         <tr>
 401           <td class="md" nowrap valign="top"> char userrec::awaymsg[512]
 402       </table>
 403     </td>
 404   </tr>
 405 </table>
 406 <table cellspacing=5 cellpadding=0 border=0>
 407   <tr>
 408     <td>
 409       &nbsp;
 410     </td>
 411     <td>
 412
 413 <p>
 414 The user's away message.
 415 <p>
 416 If this string is empty, the user is not marked as away.
 417 <p>
 418 Definition at line <a class="el" href="users_8h-source.html#l00121">121</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 419   </tr>
 420 </table>
 421 <a name="m5" doxytag="userrec::chans"></a><p>
 422 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 423   <tr>
 424     <td class="md">
 425       <table cellpadding="0" cellspacing="0" border="0">
 426         <tr>
 427           <td class="md" nowrap valign="top"> <a class="el" href="classucrec.html">ucrec</a> userrec::chans[MAXCHANS]
 428       </table>
 429     </td>
 430   </tr>
 431 </table>
 432 <table cellspacing=5 cellpadding=0 border=0>
 433   <tr>
 434     <td>
 435       &nbsp;
 436     </td>
 437     <td>
 438
 439 <p>
 440
 441 <p>
 442 Definition at line <a class="el" href="users_8h-source.html#l00112">112</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 443 <p>
 444 Referenced by <a class="el" href="users_8cpp-source.html#l00011">userrec()</a>.    </td>
 445   </tr>
 446 </table>
 447 <a name="m2" doxytag="userrec::dhost"></a><p>
 448 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 449   <tr>
 450     <td class="md">
 451       <table cellpadding="0" cellspacing="0" border="0">
 452         <tr>
 453           <td class="md" nowrap valign="top"> char userrec::dhost[256]
 454       </table>
 455     </td>
 456   </tr>
 457 </table>
 458 <table cellspacing=5 cellpadding=0 border=0>
 459   <tr>
 460     <td>
 461       &nbsp;
 462     </td>
 463     <td>
 464
 465 <p>
 466 The host displayed to non-opers (used for cloaking etc).
 467 <p>
 468 This usually matches the value of <a class="el" href="classconnection.html#m1">userrec::host</a>.
 469 <p>
 470 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>
 471   </tr>
 472 </table>
 473 <a name="m9" doxytag="userrec::flood"></a><p>
 474 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 475   <tr>
 476     <td class="md">
 477       <table cellpadding="0" cellspacing="0" border="0">
 478         <tr>
 479           <td class="md" nowrap valign="top"> int userrec::flood
 480       </table>
 481     </td>
 482   </tr>
 483 </table>
 484 <table cellspacing=5 cellpadding=0 border=0>
 485   <tr>
 486     <td>
 487       &nbsp;
 488     </td>
 489     <td>
 490
 491 <p>
 492 Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
 493 <p>
 494
 495 <p>
 496 Definition at line <a class="el" href="users_8h-source.html#l00132">132</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 497 <p>
 498 Referenced by <a class="el" href="users_8cpp-source.html#l00011">userrec()</a>.    </td>
 499   </tr>
 500 </table>
 501 <a name="m3" doxytag="userrec::fullname"></a><p>
 502 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 503   <tr>
 504     <td class="md">
 505       <table cellpadding="0" cellspacing="0" border="0">
 506         <tr>
 507           <td class="md" nowrap valign="top"> char userrec::fullname[128]
 508       </table>
 509     </td>
 510   </tr>
 511 </table>
 512 <table cellspacing=5 cellpadding=0 border=0>
 513   <tr>
 514     <td>
 515       &nbsp;
 516     </td>
 517     <td>
 518
 519 <p>
 520 The users full name.
 521 <p>
 522
 523 <p>
 524 Definition at line <a class="el" href="users_8h-source.html#l00104">104</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 525   </tr>
 526 </table>
 527 <a name="m1" doxytag="userrec::ident"></a><p>
 528 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 529   <tr>
 530     <td class="md">
 531       <table cellpadding="0" cellspacing="0" border="0">
 532         <tr>
 533           <td class="md" nowrap valign="top"> char userrec::ident[64]
 534       </table>
 535     </td>
 536   </tr>
 537 </table>
 538 <table cellspacing=5 cellpadding=0 border=0>
 539   <tr>
 540     <td>
 541       &nbsp;
 542     </td>
 543     <td>
 544
 545 <p>
 546 The users ident reply.
 547 <p>
 548
 549 <p>
 550 Definition at line <a class="el" href="users_8h-source.html#l00095">95</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 551   </tr>
 552 </table>
 553 <a name="o0" doxytag="userrec::invites"></a><p>
 554 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 555   <tr>
 556     <td class="md">
 557       <table cellpadding="0" cellspacing="0" border="0">
 558         <tr>
 559           <td class="md" nowrap valign="top"> <a class="el" href="users_8h.html#a6">InvitedList</a> userrec::invites<code> [private]</code>
 560       </table>
 561     </td>
 562   </tr>
 563 </table>
 564 <table cellspacing=5 cellpadding=0 border=0>
 565   <tr>
 566     <td>
 567       &nbsp;
 568     </td>
 569     <td>
 570
 571 <p>
 572 A list of channels the user has a pending invite to.
 573 <p>
 574
 575 <p>
 576 Definition at line <a class="el" href="users_8h-source.html#l00084">84</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 577 <p>
 578 Referenced by <a class="el" href="users_8cpp-source.html#l00066">InviteTo()</a>, <a class="el" href="users_8cpp-source.html#l00052">IsInvited()</a>, <a class="el" href="users_8cpp-source.html#l00073">RemoveInvite()</a>, and <a class="el" href="users_8cpp-source.html#l00011">userrec()</a>.    </td>
 579   </tr>
 580 </table>
 581 <a name="m4" doxytag="userrec::modes"></a><p>
 582 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 583   <tr>
 584     <td class="md">
 585       <table cellpadding="0" cellspacing="0" border="0">
 586         <tr>
 587           <td class="md" nowrap valign="top"> char userrec::modes[MAXBUF]
 588       </table>
 589     </td>
 590   </tr>
 591 </table>
 592 <table cellspacing=5 cellpadding=0 border=0>
 593   <tr>
 594     <td>
 595       &nbsp;
 596     </td>
 597     <td>
 598
 599 <p>
 600 The user's mode string.
 601 <p>
 602 This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.
 603 <p>
 604 Definition at line <a class="el" href="users_8h-source.html#l00110">110</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 605   </tr>
 606 </table>
 607 <a name="m0" doxytag="userrec::nick"></a><p>
 608 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 609   <tr>
 610     <td class="md">
 611       <table cellpadding="0" cellspacing="0" border="0">
 612         <tr>
 613           <td class="md" nowrap valign="top"> char userrec::nick[NICKMAX]
 614       </table>
 615     </td>
 616   </tr>
 617 </table>
 618 <table cellspacing=5 cellpadding=0 border=0>
 619   <tr>
 620     <td>
 621       &nbsp;
 622     </td>
 623     <td>
 624
 625 <p>
 626 The users nickname.
 627 <p>
 628 An invalid nickname indicates an unregistered connection prior to the NICK command.
 629 <p>
 630 Definition at line <a class="el" href="users_8h-source.html#l00091">91</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 631 <p>
 632 Referenced by <a class="el" href="modules_8cpp-source.html#l00176">Server::QuitUser()</a>.    </td>
 633   </tr>
 634 </table>
 635 <a name="m8" doxytag="userrec::result"></a><p>
 636 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 637   <tr>
 638     <td class="md">
 639       <table cellpadding="0" cellspacing="0" border="0">
 640         <tr>
 641           <td class="md" nowrap valign="top"> char userrec::result[256]
 642       </table>
 643     </td>
 644   </tr>
 645 </table>
 646 <table cellspacing=5 cellpadding=0 border=0>
 647   <tr>
 648     <td>
 649       &nbsp;
 650     </td>
 651     <td>
 652
 653 <p>
 654 Stores the result of the last GetFullHost or GetRealHost call.
 655 <p>
 656 You may use this to increase the speed of use of this class.
 657 <p>
 658 Definition at line <a class="el" href="users_8h-source.html#l00126">126</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 659 <p>
 660 Referenced by <a class="el" href="users_8cpp-source.html#l00039">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00046">GetFullRealHost()</a>.    </td>
 661   </tr>
 662 </table>
 663 <a name="m6" doxytag="userrec::server"></a><p>
 664 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 665   <tr>
 666     <td class="md">
 667       <table cellpadding="0" cellspacing="0" border="0">
 668         <tr>
 669           <td class="md" nowrap valign="top"> char userrec::server[256]
 670       </table>
 671     </td>
 672   </tr>
 673 </table>
 674 <table cellspacing=5 cellpadding=0 border=0>
 675   <tr>
 676     <td>
 677       &nbsp;
 678     </td>
 679     <td>
 680
 681 <p>
 682 The server the user is connected to.
 683 <p>
 684
 685 <p>
 686 Definition at line <a class="el" href="users_8h-source.html#l00116">116</a> of file <a class="el" href="users_8h-source.html">users.h</a>.    </td>
 687   </tr>
 688 </table>
 689 <a name="m10" doxytag="userrec::timeout"></a><p>
 690 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 691   <tr>
 692     <td class="md">
 693       <table cellpadding="0" cellspacing="0" border="0">
 694         <tr>
 695           <td class="md" nowrap valign="top"> unsigned long userrec::timeout
 696       </table>
 697     </td>
 698   </tr>
 699 </table>
 700 <table cellspacing=5 cellpadding=0 border=0>
 701   <tr>
 702     <td>
 703       &nbsp;
 704     </td>
 705     <td>
 706
 707 <p>
 708 Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.
 709 <p>
 710
 711 <p>
 712 Definition at line <a class="el" href="users_8h-source.html#l00138">138</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
 713 <p>
 714 Referenced by <a class="el" href="users_8cpp-source.html#l00011">userrec()</a>.    </td>
 715   </tr>
 716 </table>
 717 <hr>The documentation for this class was generated from the following files:<ul>
 718 <li><a class="el" href="users_8h-source.html">users.h</a><li><a class="el" href="users_8cpp-source.html">users.cpp</a></ul>
 719 <hr><address style="align: right;"><small>Generated on Fri Apr 30 13:23:41 2004 for InspIRCd by
 720 <a href="http://www.doxygen.org/index.html">
 721 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 722 width=110 height=53></a>1.3-rc3 </small></address>
 723 </body>
 724 </html>