diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2003-01-26 23:52:48 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2003-01-26 23:52:48 +0000 |
commit | 767b12b0ab6a0d4ed5f7335b26d1c0f842d99543 (patch) | |
tree | 016b34ac3ef9563dc564f95fb5f6d9d3f656157f /docs/module-doc/classuserrec.html | |
parent | 114b15864ac8cf4143ed415dd90b7550e2b5687c (diff) |
Modified documentation for base classes
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@150 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classuserrec.html')
-rw-r--r-- | docs/module-doc/classuserrec.html | 557 |
1 files changed, 57 insertions, 500 deletions
diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index c241c89f9..07d5cf5ed 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -11,6 +11,12 @@ <p> <code>#include <<a class="el" href="users_8h-source.html">users.h</a>></code> <p> +<p>Inheritance diagram for userrec: +<p><center><img src="classuserrec.png" usemap="#userrec_map" border="0" alt=""></center> +<map name="userrec_map"> +<area href="classconnection.html" alt="connection" shape="rect" coords="0,56,74,80"> +<area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,74,24"> +</map> <a href="classuserrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> @@ -29,52 +35,21 @@ <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m0">nick</a> [NICKMAX]</td></tr> <tr><td> </td><td><font size=-1><em>The users nickname.</em> <a href="#m0"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>unsigned long </td><td valign=bottom><a class="el" href="classuserrec.html#m1">ip</a></td></tr> -<tr><td> </td><td><font size=-1><em>The users ip address in network order.</em> <a href="#m1"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m2">ident</a> [64]</td></tr> -<tr><td> </td><td><font size=-1><em>The users ident reply.</em> <a href="#m2"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m3">host</a> [256]</td></tr> -<tr><td> </td><td><font size=-1><em>The users hostname, or ip address in string form.</em> <a href="#m3"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m4">dhost</a> [256]</td></tr> -<tr><td> </td><td><font size=-1><em>The host displayed to non-opers (used for cloaking etc).</em> <a href="#m4"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m5">fullname</a> [128]</td></tr> -<tr><td> </td><td><font size=-1><em>The users full name.</em> <a href="#m5"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classuserrec.html#m6">fd</a></td></tr> -<tr><td> </td><td><font size=-1><em>The users file descriptor.</em> <a href="#m6"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m7">modes</a> [32]</td></tr> -<tr><td> </td><td><font size=-1><em>The user's mode string.</em> <a href="#m7"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m8">inbuf</a> [MAXBUF]</td></tr> -<tr><td> </td><td><font size=-1><em>The users input buffer.</em> <a href="#m8"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m9">lastping</a></td></tr> -<tr><td> </td><td><font size=-1><em>The last time the user was pinged by the core.</em> <a href="#m9"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m10">signon</a></td></tr> -<tr><td> </td><td><font size=-1><em>The users signon time.</em> <a href="#m10"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m11">idle_lastmsg</a></td></tr> -<tr><td> </td><td><font size=-1><em>The time the user last sent a message.</em> <a href="#m11"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m12">nping</a></td></tr> -<tr><td> </td><td><font size=-1><em>True if the user replied to their last ping.</em> <a href="#m12"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classuserrec.html#m13">registered</a></td></tr> -<tr><td> </td><td><font size=-1><em>Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.</em> <a href="#m13"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top><a class="el" href="classucrec.html">ucrec</a> </td><td valign=bottom><a class="el" href="classuserrec.html#m14">chans</a> [MAXCHANS]</td></tr> -<tr><td> </td><td><font size=-1><em>A list of the channels the user is currently on.</em> <a href="#m14"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m15">server</a> [256]</td></tr> -<tr><td> </td><td><font size=-1><em>The server the user is connected to.</em> <a href="#m15"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m16">awaymsg</a> [512]</td></tr> -<tr><td> </td><td><font size=-1><em>The user's away message.</em> <a href="#m16"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classuserrec.html#m17">port</a></td></tr> -<tr><td> </td><td><font size=-1><em>The port that the user connected to.</em> <a href="#m17"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m18">bytes_in</a></td></tr> -<tr><td> </td><td><font size=-1><em>Stores the number of incoming bytes from the connection.</em> <a href="#m18"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m19">bytes_out</a></td></tr> -<tr><td> </td><td><font size=-1><em>Stores the number of outgoing bytes to the connection.</em> <a href="#m19"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m20">cmds_in</a></td></tr> -<tr><td> </td><td><font size=-1><em>Stores the number of incoming commands from the connection.</em> <a href="#m20"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m21">cmds_out</a></td></tr> -<tr><td> </td><td><font size=-1><em>Stores the number of outgoing commands to the connection.</em> <a href="#m21"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m22">result</a> [256]</td></tr> -<tr><td> </td><td><font size=-1><em>Stores the result of the last GetFullHost or GetRealHost call.</em> <a href="#m22"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classuserrec.html#m23">haspassed</a></td></tr> -<tr><td> </td><td><font size=-1><em>True if a correct password has been given using PASS command.</em> <a href="#m23"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m1">ident</a> [64]</td></tr> +<tr><td> </td><td><font size=-1><em>The users ident reply.</em> <a href="#m1"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m2">dhost</a> [256]</td></tr> +<tr><td> </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> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m3">fullname</a> [128]</td></tr> +<tr><td> </td><td><font size=-1><em>The users full name.</em> <a href="#m3"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m4">modes</a> [32]</td></tr> +<tr><td> </td><td><font size=-1><em>The user's mode string.</em> <a href="#m4"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classucrec.html">ucrec</a> </td><td valign=bottom><a class="el" href="classuserrec.html#m5">chans</a> [MAXCHANS]</td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m6">server</a> [256]</td></tr> +<tr><td> </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> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m7">awaymsg</a> [512]</td></tr> +<tr><td> </td><td><font size=-1><em>The user's away message.</em> <a href="#m7"></a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m8">result</a> [256]</td></tr> +<tr><td> </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> <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="users_8h.html#a6">InvitedList</a> </td><td valign=bottom><a class="el" href="classuserrec.html#o0">invites</a></td></tr> <tr><td> </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> @@ -86,7 +61,7 @@ Everything about a connection is stored here primarily, from the user's socket I <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00083">83</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +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>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="userrec::userrec"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -116,12 +91,12 @@ Definition at line <a class="el" href="users_8h-source.html#l00083">83</a> of fi <p> Definition at line <a class="el" href="users_8cpp-source.html#l00026">26</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00186">bytes_in</a>, <a class="el" href="users_8h-source.html#l00191">bytes_out</a>, <a class="el" href="channels_8h-source.html#l00192">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00168">chans</a>, <a class="el" href="users_8h-source.html#l00196">cmds_in</a>, <a class="el" href="users_8h-source.html#l00201">cmds_out</a>, <a class="el" href="users_8h-source.html#l00123">fd</a>, <a class="el" href="users_8h-source.html#l00212">haspassed</a>, <a class="el" href="users_8h-source.html#l00150">idle_lastmsg</a>, <a class="el" href="users_8h-source.html#l00089">invites</a>, <a class="el" href="users_8h-source.html#l00100">ip</a>, <a class="el" href="users_8h-source.html#l00141">lastping</a>, <a class="el" href="users_8h-source.html#l00156">nping</a>, <a class="el" href="users_8h-source.html#l00181">port</a>, <a class="el" href="users_8h-source.html#l00162">registered</a>, and <a class="el" href="users_8h-source.html#l00145">signon</a>. +References <a class="el" href="connection_8h-source.html#l00025">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00026">connection::bytes_out</a>, <a class="el" href="channels_8h-source.html#l00193">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00118">chans</a>, <a class="el" href="connection_8h-source.html#l00027">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00028">connection::cmds_out</a>, <a class="el" href="connection_8h-source.html#l00021">connection::fd</a>, <a class="el" href="connection_8h-source.html#l00029">connection::haspassed</a>, <a class="el" href="connection_8h-source.html#l00034">connection::idle_lastmsg</a>, <a class="el" href="users_8h-source.html#l00090">invites</a>, <a class="el" href="connection_8h-source.html#l00023">connection::ip</a>, <a class="el" href="connection_8h-source.html#l00032">connection::lastping</a>, <a class="el" href="connection_8h-source.html#l00035">connection::nping</a>, <a class="el" href="connection_8h-source.html#l00030">connection::port</a>, <a class="el" href="connection_8h-source.html#l00031">connection::registered</a>, and <a class="el" href="connection_8h-source.html#l00033">connection::signon</a>. <p> <div class="fragment"><pre>00027 { 00028 <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span> 00029 strcpy(nick,<span class="stringliteral">""</span>); -00030 <a class="code" href="classuserrec.html#m1">ip</a> = 0; +00030 <a class="code" href="classconnection.html#m2">ip</a> = 0; 00031 strcpy(ident,<span class="stringliteral">""</span>); 00032 strcpy(host,<span class="stringliteral">""</span>); 00033 strcpy(dhost,<span class="stringliteral">""</span>); @@ -130,13 +105,13 @@ References <a class="el" href="users_8h-source.html#l00186">bytes_in</a>, <a cla 00036 strcpy(inbuf,<span class="stringliteral">""</span>); 00037 strcpy(server,<span class="stringliteral">""</span>); 00038 strcpy(awaymsg,<span class="stringliteral">""</span>); -00039 <a class="code" href="classuserrec.html#m6">fd</a> = <a class="code" href="classuserrec.html#m9">lastping</a> = <a class="code" href="classuserrec.html#m10">signon</a> = <a class="code" href="classuserrec.html#m11">idle_lastmsg</a> = <a class="code" href="classuserrec.html#m12">nping</a> = <a class="code" href="classuserrec.html#m13">registered</a> = 0; -00040 <a class="code" href="classuserrec.html#m17">port</a> = <a class="code" href="classuserrec.html#m18">bytes_in</a> = <a class="code" href="classuserrec.html#m19">bytes_out</a> = <a class="code" href="classuserrec.html#m20">cmds_in</a> = <a class="code" href="classuserrec.html#m21">cmds_out</a> = 0; -00041 <a class="code" href="classuserrec.html#m23">haspassed</a> = <span class="keyword">false</span>; +00039 <a class="code" href="classconnection.html#m0">fd</a> = <a class="code" href="classconnection.html#m11">lastping</a> = <a class="code" href="classconnection.html#m12">signon</a> = <a class="code" href="classconnection.html#m13">idle_lastmsg</a> = <a class="code" href="classconnection.html#m14">nping</a> = <a class="code" href="classconnection.html#m10">registered</a> = 0; +00040 <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; +00041 <a class="code" href="classconnection.html#m8">haspassed</a> = <span class="keyword">false</span>; 00042 strcpy(result,<span class="stringliteral">""</span>); 00043 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < MAXCHANS; i++) 00044 { -00045 <a class="code" href="classuserrec.html#m14">chans</a>[i].<a class="code" href="classucrec.html#m1">channel</a> = NULL; +00045 <a class="code" href="classuserrec.html#m5">chans</a>[i].<a class="code" href="classucrec.html#m1">channel</a> = NULL; 00046 } 00047 <a class="code" href="classuserrec.html#o0">invites</a>.clear(); 00048 } @@ -170,9 +145,9 @@ References <a class="el" href="users_8h-source.html#l00186">bytes_in</a>, <a cla <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00216">216</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00136">136</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> -<div class="fragment"><pre>00216 { } +<div class="fragment"><pre>00136 { } </pre></div> </td> </tr> </table> @@ -208,11 +183,11 @@ Returns the full displayed host of the user This member function returns the hos <p> Definition at line <a class="el" href="users_8cpp-source.html#l00051">51</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00206">result</a>. +References <a class="el" href="users_8h-source.html#l00132">result</a>. <p> <div class="fragment"><pre>00052 { 00053 sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost); -00054 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m22">result</a>; +00054 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>; 00055 } </pre></div> </td> </tr> @@ -248,11 +223,11 @@ If any form of hostname cloaking is in operation, e.g. through a module, then th <p> Definition at line <a class="el" href="users_8cpp-source.html#l00058">58</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00206">result</a>. +References <a class="el" href="users_8h-source.html#l00132">result</a>. <p> <div class="fragment"><pre>00059 { 00060 sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host); -00061 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m22">result</a>; +00061 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m8">result</a>; 00062 } </pre></div> </td> </tr> @@ -289,7 +264,7 @@ Adds a channel to a users invite list (invites them to a channel). <p> Definition at line <a class="el" href="users_8cpp-source.html#l00075">75</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00053">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00089">invites</a>. +References <a class="el" href="users_8h-source.html#l00054">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00090">invites</a>. <p> <div class="fragment"><pre>00076 { 00077 <a class="code" href="classInvited.html">Invited</a> i; @@ -331,7 +306,7 @@ Returns true if a user is invited to a channel. <p> Definition at line <a class="el" href="users_8cpp-source.html#l00064">64</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00089">invites</a>. +References <a class="el" href="users_8h-source.html#l00090">invites</a>. <p> <div class="fragment"><pre>00065 { 00066 <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,7 +352,7 @@ This member function is called on successfully joining an invite only channel to <p> Definition at line <a class="el" href="users_8cpp-source.html#l00082">82</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00089">invites</a>. +References <a class="el" href="users_8h-source.html#l00090">invites</a>. <p> <div class="fragment"><pre>00083 { 00084 <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++) @@ -393,7 +368,7 @@ References <a class="el" href="users_8h-source.html#l00089">invites</a>. </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="m16" doxytag="userrec::awaymsg"></a><p> +<a name="m7" doxytag="userrec::awaymsg"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -416,66 +391,10 @@ The user's away message. <p> If this string is empty, the user is not marked as away. <p> -Definition at line <a class="el" href="users_8h-source.html#l00177">177</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +Definition at line <a class="el" href="users_8h-source.html#l00127">127</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="m18" doxytag="userrec::bytes_in"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> long userrec::bytes_in - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Stores the number of incoming bytes from the connection. -<p> -Used by /STATS -<p> -Definition at line <a class="el" href="users_8h-source.html#l00186">186</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m19" doxytag="userrec::bytes_out"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> long userrec::bytes_out - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Stores the number of outgoing bytes to the connection. -<p> -Used by /STATS -<p> -Definition at line <a class="el" href="users_8h-source.html#l00191">191</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m14" doxytag="userrec::chans"></a><p> +<a name="m5" doxytag="userrec::chans"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -494,72 +413,14 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. <td> <p> -A list of the channels the user is currently on. -<p> -If any of these values are NULL, the record is not in use and may be associated with a channel by the JOIN command. see RFC 1459. -<p> -Definition at line <a class="el" href="users_8h-source.html#l00168">168</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m20" doxytag="userrec::cmds_in"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> long userrec::cmds_in - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> <p> -Stores the number of incoming commands from the connection. -<p> -Used by /STATS -<p> -Definition at line <a class="el" href="users_8h-source.html#l00196">196</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00118">118</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> </tr> </table> -<a name="m21" doxytag="userrec::cmds_out"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> long userrec::cmds_out - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Stores the number of outgoing commands to the connection. -<p> -Used by /STATS -<p> -Definition at line <a class="el" href="users_8h-source.html#l00201">201</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m4" doxytag="userrec::dhost"></a><p> +<a name="m2" doxytag="userrec::dhost"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -580,40 +441,12 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. <p> The host displayed to non-opers (used for cloaking etc). <p> -This usually matches the value of <a class="el" href="classuserrec.html#m3">userrec::host</a>. +This usually matches the value of <a class="el" href="classconnection.html#m1">userrec::host</a>. <p> -Definition at line <a class="el" href="users_8h-source.html#l00113">113</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +Definition at line <a class="el" href="users_8h-source.html#l00106">106</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> -<a name="m6" doxytag="userrec::fd"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> int userrec::fd - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The users file descriptor. -<p> -If this is zero, the socket has been closed and the core has not yet realised and removed the record from memory. -<p> -Definition at line <a class="el" href="users_8h-source.html#l00123">123</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m5" doxytag="userrec::fullname"></a><p> +<a name="m3" doxytag="userrec::fullname"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -636,64 +469,10 @@ The users full name. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00117">117</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> - </tr> -</table> -<a name="m23" doxytag="userrec::haspassed"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> bool userrec::haspassed - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -True if a correct password has been given using PASS command. -<p> -If the user is a member of a connection class that does not require a password, the value stored here is of no use. -<p> -Definition at line <a class="el" href="users_8h-source.html#l00212">212</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m3" doxytag="userrec::host"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> char userrec::host[256] - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The users hostname, or ip address in string form. -<p> - -<p> -Definition at line <a class="el" href="users_8h-source.html#l00108">108</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +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> </tr> </table> -<a name="m2" doxytag="userrec::ident"></a><p> +<a name="m1" doxytag="userrec::ident"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -716,61 +495,7 @@ The users ident reply. <p> <p> -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> - </tr> -</table> -<a name="m11" doxytag="userrec::idle_lastmsg"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> time_t userrec::idle_lastmsg - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The time the user last sent a message. -<p> -See also <a class="el" href="classuserrec.html#m9">userrec::lastping</a> and <a class="el" href="classuserrec.html#m10">userrec::signon</a> -<p> -Definition at line <a class="el" href="users_8h-source.html#l00150">150</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m8" doxytag="userrec::inbuf"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> char userrec::inbuf[MAXBUF] - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The users input buffer. -<p> -Used by the C recv() function. -<p> -Definition at line <a class="el" href="users_8h-source.html#l00134">134</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +Definition at line <a class="el" href="users_8h-source.html#l00101">101</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> <a name="o0" doxytag="userrec::invites"></a><p> @@ -796,68 +521,12 @@ A list of channels the user has a pending invite to. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00089">89</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00090">90</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00075">InviteTo()</a>, <a class="el" href="users_8cpp-source.html#l00064">IsInvited()</a>, <a class="el" href="users_8cpp-source.html#l00082">RemoveInvite()</a>, and <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> </tr> </table> -<a name="m1" doxytag="userrec::ip"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> unsigned long userrec::ip - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The users ip address in network order. -<p> - -<p> -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>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m9" doxytag="userrec::lastping"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> time_t userrec::lastping - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The last time the user was pinged by the core. -<p> -When this value is more than 120 seconds difference from 'time(NULL)', a ping is sent to the client. If the user has an outstanding PING request the next time this event occurs after 4 total minutes, they are disconnected. -<p> -Definition at line <a class="el" href="users_8h-source.html#l00141">141</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m7" doxytag="userrec::modes"></a><p> +<a name="m4" doxytag="userrec::modes"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -880,7 +549,7 @@ The user's mode string. <p> This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. <p> -Definition at line <a class="el" href="users_8h-source.html#l00129">129</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +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> </tr> </table> <a name="m0" doxytag="userrec::nick"></a><p> @@ -906,94 +575,10 @@ The users nickname. <p> An invalid nickname indicates an unregistered connection prior to the NICK command. <p> -Definition at line <a class="el" href="users_8h-source.html#l00096">96</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> - </tr> -</table> -<a name="m12" doxytag="userrec::nping"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> time_t userrec::nping - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -True if the user replied to their last ping. -<p> -If this is true, the user can be sent another ping at the specified time, otherwise they will be discnnected. See also <a class="el" href="classuserrec.html#m9">userrec::lastping</a> -<p> -Definition at line <a class="el" href="users_8h-source.html#l00156">156</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m17" doxytag="userrec::port"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> int userrec::port - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The port that the user connected to. -<p> - -<p> -Definition at line <a class="el" href="users_8h-source.html#l00181">181</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> - </tr> -</table> -<a name="m13" doxytag="userrec::registered"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> int userrec::registered - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command. -<p> -If both bits are set then the connection is awaiting MOTD. Sending of MOTD sets bit 3, and makes the value of <a class="el" href="classuserrec.html#m13">userrec::registered</a> == 7, showing a fully established client session. -<p> -Definition at line <a class="el" href="users_8h-source.html#l00162">162</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> +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> </tr> </table> -<a name="m22" doxytag="userrec::result"></a><p> +<a name="m8" doxytag="userrec::result"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -1016,12 +601,12 @@ Stores the result of the last GetFullHost or GetRealHost call. <p> You may use this to increase the speed of use of this class. <p> -Definition at line <a class="el" href="users_8h-source.html#l00206">206</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +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>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00051">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00058">GetFullRealHost()</a>. </td> </tr> </table> -<a name="m15" doxytag="userrec::server"></a><p> +<a name="m6" doxytag="userrec::server"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> @@ -1044,40 +629,12 @@ The server the user is connected to. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00172">172</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> - </tr> -</table> -<a name="m10" doxytag="userrec::signon"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top"> time_t userrec::signon - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -The users signon time. -<p> - -<p> -Definition at line <a class="el" href="users_8h-source.html#l00145">145</a> of file <a class="el" href="users_8h-source.html">users.h</a>. -<p> -Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td> +Definition at line <a class="el" href="users_8h-source.html#l00122">122</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <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> -<hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by +<hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.3-rc2 </small></address> |