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