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="doxygen.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3-rc2 -->
8 <a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </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>
12 <code>#include <<a class="el" href="users_8h-source.html">users.h</a>></code>
14 <a href="classuserrec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
17 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classuserrec.html#a0">userrec</a> ()</td></tr>
18 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classuserrec.html#a1">~userrec</a> ()</td></tr>
19 <tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="classuserrec.html#a2">GetFullHost</a> ()</td></tr>
20 <tr><td> </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>
21 <tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="classuserrec.html#a3">GetFullRealHost</a> ()</td></tr>
22 <tr><td> </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>
23 <tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classuserrec.html#a4">IsInvited</a> (char *channel)</td></tr>
24 <tr><td> </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>
25 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classuserrec.html#a5">InviteTo</a> (char *channel)</td></tr>
26 <tr><td> </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>
27 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classuserrec.html#a6">RemoveInvite</a> (char *channel)</td></tr>
28 <tr><td> </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>
29 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
30 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m0">nick</a> [NICKMAX]</td></tr>
31 <tr><td> </td><td><font size=-1><em>The users nickname.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
32 <tr><td nowrap align=right valign=top>unsigned long </td><td valign=bottom><a class="el" href="classuserrec.html#m1">ip</a></td></tr>
33 <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>
34 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m2">ident</a> [64]</td></tr>
35 <tr><td> </td><td><font size=-1><em>The users ident reply.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
36 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m3">host</a> [256]</td></tr>
37 <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>
38 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m4">dhost</a> [256]</td></tr>
39 <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>
40 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m5">fullname</a> [128]</td></tr>
41 <tr><td> </td><td><font size=-1><em>The users full name.</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
42 <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classuserrec.html#m6">fd</a></td></tr>
43 <tr><td> </td><td><font size=-1><em>The users file descriptor.</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
44 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m7">modes</a> [32]</td></tr>
45 <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>
46 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m8">inbuf</a> [MAXBUF]</td></tr>
47 <tr><td> </td><td><font size=-1><em>The users input buffer.</em> <a href="#m8"></a><em></em></font><br><br></td></tr>
48 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m9">lastping</a></td></tr>
49 <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>
50 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m10">signon</a></td></tr>
51 <tr><td> </td><td><font size=-1><em>The users signon time.</em> <a href="#m10"></a><em></em></font><br><br></td></tr>
52 <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>
53 <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>
54 <tr><td nowrap align=right valign=top>time_t </td><td valign=bottom><a class="el" href="classuserrec.html#m12">nping</a></td></tr>
55 <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>
56 <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classuserrec.html#m13">registered</a></td></tr>
57 <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>
58 <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>
59 <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>
60 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m15">server</a> [256]</td></tr>
61 <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>
62 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m16">awaymsg</a> [512]</td></tr>
63 <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>
64 <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classuserrec.html#m17">port</a></td></tr>
65 <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>
66 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m18">bytes_in</a></td></tr>
67 <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>
68 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m19">bytes_out</a></td></tr>
69 <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>
70 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m20">cmds_in</a></td></tr>
71 <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>
72 <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classuserrec.html#m21">cmds_out</a></td></tr>
73 <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>
74 <tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classuserrec.html#m22">result</a> [256]</td></tr>
75 <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>
76 <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classuserrec.html#m23">haspassed</a></td></tr>
77 <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>
78 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
79 <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>
80 <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>
82 <hr><a name="_details"></a><h2>Detailed Description</h2>
83 Holds all information about a user This class stores all information about a user connected to the irc server.
85 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.
89 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>
90 <a name="a0" doxytag="userrec::userrec"></a><p>
91 <table width="100%" cellpadding="2" cellspacing="0" border="0">
94 <table cellpadding="0" cellspacing="0" border="0">
96 <td class="md" nowrap valign="top"> userrec::userrec </td>
97 <td class="md" valign="top">( </td>
98 <td class="mdname1" valign="top" nowrap> </td>
99 <td class="md" valign="top">) </td>
100 <td class="md" nowrap></td>
107 <table cellspacing=5 cellpadding=0 border=0>
117 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>.
119 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>.
121 <div class="fragment"><pre>00027 {
122 00028 <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span>
123 00029 strcpy(nick,<span class="stringliteral">""</span>);
124 00030 <a class="code" href="classuserrec.html#m1">ip</a> = 0;
125 00031 strcpy(ident,<span class="stringliteral">""</span>);
126 00032 strcpy(host,<span class="stringliteral">""</span>);
127 00033 strcpy(dhost,<span class="stringliteral">""</span>);
128 00034 strcpy(fullname,<span class="stringliteral">""</span>);
129 00035 strcpy(modes,<span class="stringliteral">""</span>);
130 00036 strcpy(inbuf,<span class="stringliteral">""</span>);
131 00037 strcpy(server,<span class="stringliteral">""</span>);
132 00038 strcpy(awaymsg,<span class="stringliteral">""</span>);
133 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;
134 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;
135 00041 <a class="code" href="classuserrec.html#m23">haspassed</a> = <span class="keyword">false</span>;
136 00042 strcpy(result,<span class="stringliteral">""</span>);
137 00043 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < MAXCHANS; i++)
139 00045 <a class="code" href="classuserrec.html#m14">chans</a>[i].<a class="code" href="classucrec.html#m1">channel</a> = NULL;
141 00047 <a class="code" href="classuserrec.html#o0">invites</a>.clear();
146 <a name="a1" doxytag="userrec::~userrec"></a><p>
147 <table width="100%" cellpadding="2" cellspacing="0" border="0">
150 <table cellpadding="0" cellspacing="0" border="0">
152 <td class="md" nowrap valign="top"> virtual userrec::~userrec </td>
153 <td class="md" valign="top">( </td>
154 <td class="mdname1" valign="top" nowrap> </td>
155 <td class="md" valign="top">) </td>
156 <td class="md" nowrap><code> [inline, virtual]</code></td>
163 <table cellspacing=5 cellpadding=0 border=0>
173 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>.
175 <div class="fragment"><pre>00216 { }
179 <hr><h2>Member Function Documentation</h2>
180 <a name="a2" doxytag="userrec::GetFullHost"></a><p>
181 <table width="100%" cellpadding="2" cellspacing="0" border="0">
184 <table cellpadding="0" cellspacing="0" border="0">
186 <td class="md" nowrap valign="top"> char * userrec::GetFullHost </td>
187 <td class="md" valign="top">( </td>
188 <td class="mdname1" valign="top" nowrap> </td>
189 <td class="md" valign="top">) </td>
190 <td class="md" nowrap><code> [virtual]</code></td>
197 <table cellspacing=5 cellpadding=0 border=0>
205 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.
209 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>.
211 References <a class="el" href="users_8h-source.html#l00206">result</a>.
213 <div class="fragment"><pre>00052 {
214 00053 sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost);
215 00054 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m22">result</a>;
220 <a name="a3" doxytag="userrec::GetFullRealHost"></a><p>
221 <table width="100%" cellpadding="2" cellspacing="0" border="0">
224 <table cellpadding="0" cellspacing="0" border="0">
226 <td class="md" nowrap valign="top"> char * userrec::GetFullRealHost </td>
227 <td class="md" valign="top">( </td>
228 <td class="mdname1" valign="top" nowrap> </td>
229 <td class="md" valign="top">) </td>
230 <td class="md" nowrap><code> [virtual]</code></td>
237 <table cellspacing=5 cellpadding=0 border=0>
245 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.
247 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.
249 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>.
251 References <a class="el" href="users_8h-source.html#l00206">result</a>.
253 <div class="fragment"><pre>00059 {
254 00060 sprintf(result,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host);
255 00061 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#m22">result</a>;
260 <a name="a5" doxytag="userrec::InviteTo"></a><p>
261 <table width="100%" cellpadding="2" cellspacing="0" border="0">
264 <table cellpadding="0" cellspacing="0" border="0">
266 <td class="md" nowrap valign="top"> void userrec::InviteTo </td>
267 <td class="md" valign="top">( </td>
268 <td class="md" nowrap valign="top">char * </td>
269 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
270 <td class="md" valign="top">) </td>
271 <td class="md" nowrap><code> [virtual]</code></td>
278 <table cellspacing=5 cellpadding=0 border=0>
286 Adds a channel to a users invite list (invites them to a channel).
290 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>.
292 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>.
294 <div class="fragment"><pre>00076 {
295 00077 <a class="code" href="classInvited.html">Invited</a> i;
296 00078 strcpy(i.<a class="code" href="classInvited.html#m0">channel</a>,channel);
297 00079 <a class="code" href="classuserrec.html#o0">invites</a>.push_back(i);
302 <a name="a4" doxytag="userrec::IsInvited"></a><p>
303 <table width="100%" cellpadding="2" cellspacing="0" border="0">
306 <table cellpadding="0" cellspacing="0" border="0">
308 <td class="md" nowrap valign="top"> bool userrec::IsInvited </td>
309 <td class="md" valign="top">( </td>
310 <td class="md" nowrap valign="top">char * </td>
311 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
312 <td class="md" valign="top">) </td>
313 <td class="md" nowrap><code> [virtual]</code></td>
320 <table cellspacing=5 cellpadding=0 border=0>
328 Returns true if a user is invited to a channel.
332 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>.
334 References <a class="el" href="users_8h-source.html#l00089">invites</a>.
336 <div class="fragment"><pre>00065 {
337 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++)
339 00068 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel))
341 00070 <span class="keywordflow">return</span> <span class="keyword">true</span>;
348 <a name="a6" doxytag="userrec::RemoveInvite"></a><p>
349 <table width="100%" cellpadding="2" cellspacing="0" border="0">
352 <table cellpadding="0" cellspacing="0" border="0">
354 <td class="md" nowrap valign="top"> void userrec::RemoveInvite </td>
355 <td class="md" valign="top">( </td>
356 <td class="md" nowrap valign="top">char * </td>
357 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
358 <td class="md" valign="top">) </td>
359 <td class="md" nowrap><code> [virtual]</code></td>
366 <table cellspacing=5 cellpadding=0 border=0>
374 Removes a channel from a users invite list.
376 This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
378 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>.
380 References <a class="el" href="users_8h-source.html#l00089">invites</a>.
382 <div class="fragment"><pre>00083 {
383 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++)
385 00086 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel))
387 00088 <a class="code" href="classuserrec.html#o0">invites</a>.erase(i);
388 00089 <span class="keywordflow">return</span>;
395 <hr><h2>Member Data Documentation</h2>
396 <a name="m16" doxytag="userrec::awaymsg"></a><p>
397 <table width="100%" cellpadding="2" cellspacing="0" border="0">
400 <table cellpadding="0" cellspacing="0" border="0">
402 <td class="md" nowrap valign="top"> char userrec::awaymsg[512]
407 <table cellspacing=5 cellpadding=0 border=0>
415 The user's away message.
417 If this string is empty, the user is not marked as away.
419 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>
422 <a name="m18" doxytag="userrec::bytes_in"></a><p>
423 <table width="100%" cellpadding="2" cellspacing="0" border="0">
426 <table cellpadding="0" cellspacing="0" border="0">
428 <td class="md" nowrap valign="top"> long userrec::bytes_in
433 <table cellspacing=5 cellpadding=0 border=0>
441 Stores the number of incoming bytes from the connection.
445 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>.
447 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
450 <a name="m19" doxytag="userrec::bytes_out"></a><p>
451 <table width="100%" cellpadding="2" cellspacing="0" border="0">
454 <table cellpadding="0" cellspacing="0" border="0">
456 <td class="md" nowrap valign="top"> long userrec::bytes_out
461 <table cellspacing=5 cellpadding=0 border=0>
469 Stores the number of outgoing bytes to the connection.
473 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>.
475 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
478 <a name="m14" doxytag="userrec::chans"></a><p>
479 <table width="100%" cellpadding="2" cellspacing="0" border="0">
482 <table cellpadding="0" cellspacing="0" border="0">
484 <td class="md" nowrap valign="top"> <a class="el" href="classucrec.html">ucrec</a> userrec::chans[MAXCHANS]
489 <table cellspacing=5 cellpadding=0 border=0>
497 A list of the channels the user is currently on.
499 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.
501 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>.
503 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
506 <a name="m20" doxytag="userrec::cmds_in"></a><p>
507 <table width="100%" cellpadding="2" cellspacing="0" border="0">
510 <table cellpadding="0" cellspacing="0" border="0">
512 <td class="md" nowrap valign="top"> long userrec::cmds_in
517 <table cellspacing=5 cellpadding=0 border=0>
525 Stores the number of incoming commands from the connection.
529 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>.
531 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
534 <a name="m21" doxytag="userrec::cmds_out"></a><p>
535 <table width="100%" cellpadding="2" cellspacing="0" border="0">
538 <table cellpadding="0" cellspacing="0" border="0">
540 <td class="md" nowrap valign="top"> long userrec::cmds_out
545 <table cellspacing=5 cellpadding=0 border=0>
553 Stores the number of outgoing commands to the connection.
557 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>.
559 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
562 <a name="m4" doxytag="userrec::dhost"></a><p>
563 <table width="100%" cellpadding="2" cellspacing="0" border="0">
566 <table cellpadding="0" cellspacing="0" border="0">
568 <td class="md" nowrap valign="top"> char userrec::dhost[256]
573 <table cellspacing=5 cellpadding=0 border=0>
581 The host displayed to non-opers (used for cloaking etc).
583 This usually matches the value of <a class="el" href="classuserrec.html#m3">userrec::host</a>.
585 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>
588 <a name="m6" doxytag="userrec::fd"></a><p>
589 <table width="100%" cellpadding="2" cellspacing="0" border="0">
592 <table cellpadding="0" cellspacing="0" border="0">
594 <td class="md" nowrap valign="top"> int userrec::fd
599 <table cellspacing=5 cellpadding=0 border=0>
607 The users file descriptor.
609 If this is zero, the socket has been closed and the core has not yet realised and removed the record from memory.
611 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>.
613 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
616 <a name="m5" doxytag="userrec::fullname"></a><p>
617 <table width="100%" cellpadding="2" cellspacing="0" border="0">
620 <table cellpadding="0" cellspacing="0" border="0">
622 <td class="md" nowrap valign="top"> char userrec::fullname[128]
627 <table cellspacing=5 cellpadding=0 border=0>
639 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>
642 <a name="m23" doxytag="userrec::haspassed"></a><p>
643 <table width="100%" cellpadding="2" cellspacing="0" border="0">
646 <table cellpadding="0" cellspacing="0" border="0">
648 <td class="md" nowrap valign="top"> bool userrec::haspassed
653 <table cellspacing=5 cellpadding=0 border=0>
661 True if a correct password has been given using PASS command.
663 If the user is a member of a connection class that does not require a password, the value stored here is of no use.
665 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>.
667 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
670 <a name="m3" doxytag="userrec::host"></a><p>
671 <table width="100%" cellpadding="2" cellspacing="0" border="0">
674 <table cellpadding="0" cellspacing="0" border="0">
676 <td class="md" nowrap valign="top"> char userrec::host[256]
681 <table cellspacing=5 cellpadding=0 border=0>
689 The users hostname, or ip address in string form.
693 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>
696 <a name="m2" doxytag="userrec::ident"></a><p>
697 <table width="100%" cellpadding="2" cellspacing="0" border="0">
700 <table cellpadding="0" cellspacing="0" border="0">
702 <td class="md" nowrap valign="top"> char userrec::ident[64]
707 <table cellspacing=5 cellpadding=0 border=0>
715 The users ident reply.
719 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>
722 <a name="m11" doxytag="userrec::idle_lastmsg"></a><p>
723 <table width="100%" cellpadding="2" cellspacing="0" border="0">
726 <table cellpadding="0" cellspacing="0" border="0">
728 <td class="md" nowrap valign="top"> time_t userrec::idle_lastmsg
733 <table cellspacing=5 cellpadding=0 border=0>
741 The time the user last sent a message.
743 See also <a class="el" href="classuserrec.html#m9">userrec::lastping</a> and <a class="el" href="classuserrec.html#m10">userrec::signon</a>
745 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>.
747 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
750 <a name="m8" doxytag="userrec::inbuf"></a><p>
751 <table width="100%" cellpadding="2" cellspacing="0" border="0">
754 <table cellpadding="0" cellspacing="0" border="0">
756 <td class="md" nowrap valign="top"> char userrec::inbuf[MAXBUF]
761 <table cellspacing=5 cellpadding=0 border=0>
769 The users input buffer.
771 Used by the C recv() function.
773 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>
776 <a name="o0" doxytag="userrec::invites"></a><p>
777 <table width="100%" cellpadding="2" cellspacing="0" border="0">
780 <table cellpadding="0" cellspacing="0" border="0">
782 <td class="md" nowrap valign="top"> <a class="el" href="users_8h.html#a6">InvitedList</a> userrec::invites<code> [private]</code>
787 <table cellspacing=5 cellpadding=0 border=0>
795 A list of channels the user has a pending invite to.
799 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>.
801 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>
804 <a name="m1" doxytag="userrec::ip"></a><p>
805 <table width="100%" cellpadding="2" cellspacing="0" border="0">
808 <table cellpadding="0" cellspacing="0" border="0">
810 <td class="md" nowrap valign="top"> unsigned long userrec::ip
815 <table cellspacing=5 cellpadding=0 border=0>
823 The users ip address in network order.
827 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>.
829 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
832 <a name="m9" doxytag="userrec::lastping"></a><p>
833 <table width="100%" cellpadding="2" cellspacing="0" border="0">
836 <table cellpadding="0" cellspacing="0" border="0">
838 <td class="md" nowrap valign="top"> time_t userrec::lastping
843 <table cellspacing=5 cellpadding=0 border=0>
851 The last time the user was pinged by the core.
853 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.
855 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>.
857 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
860 <a name="m7" doxytag="userrec::modes"></a><p>
861 <table width="100%" cellpadding="2" cellspacing="0" border="0">
864 <table cellpadding="0" cellspacing="0" border="0">
866 <td class="md" nowrap valign="top"> char userrec::modes[32]
871 <table cellspacing=5 cellpadding=0 border=0>
879 The user's mode string.
881 This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.
883 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>
886 <a name="m0" doxytag="userrec::nick"></a><p>
887 <table width="100%" cellpadding="2" cellspacing="0" border="0">
890 <table cellpadding="0" cellspacing="0" border="0">
892 <td class="md" nowrap valign="top"> char userrec::nick[NICKMAX]
897 <table cellspacing=5 cellpadding=0 border=0>
907 An invalid nickname indicates an unregistered connection prior to the NICK command.
909 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>
912 <a name="m12" doxytag="userrec::nping"></a><p>
913 <table width="100%" cellpadding="2" cellspacing="0" border="0">
916 <table cellpadding="0" cellspacing="0" border="0">
918 <td class="md" nowrap valign="top"> time_t userrec::nping
923 <table cellspacing=5 cellpadding=0 border=0>
931 True if the user replied to their last ping.
933 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>
935 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>.
937 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
940 <a name="m17" doxytag="userrec::port"></a><p>
941 <table width="100%" cellpadding="2" cellspacing="0" border="0">
944 <table cellpadding="0" cellspacing="0" border="0">
946 <td class="md" nowrap valign="top"> int userrec::port
951 <table cellspacing=5 cellpadding=0 border=0>
959 The port that the user connected to.
963 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>.
965 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
968 <a name="m13" doxytag="userrec::registered"></a><p>
969 <table width="100%" cellpadding="2" cellspacing="0" border="0">
972 <table cellpadding="0" cellspacing="0" border="0">
974 <td class="md" nowrap valign="top"> int userrec::registered
979 <table cellspacing=5 cellpadding=0 border=0>
987 Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.
989 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.
991 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>.
993 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
996 <a name="m22" doxytag="userrec::result"></a><p>
997 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1000 <table cellpadding="0" cellspacing="0" border="0">
1002 <td class="md" nowrap valign="top"> char userrec::result[256]
1007 <table cellspacing=5 cellpadding=0 border=0>
1015 Stores the result of the last GetFullHost or GetRealHost call.
1017 You may use this to increase the speed of use of this class.
1019 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>.
1021 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>
1024 <a name="m15" doxytag="userrec::server"></a><p>
1025 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1028 <table cellpadding="0" cellspacing="0" border="0">
1030 <td class="md" nowrap valign="top"> char userrec::server[256]
1035 <table cellspacing=5 cellpadding=0 border=0>
1043 The server the user is connected to.
1047 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>
1050 <a name="m10" doxytag="userrec::signon"></a><p>
1051 <table width="100%" cellpadding="2" cellspacing="0" border="0">
1054 <table cellpadding="0" cellspacing="0" border="0">
1056 <td class="md" nowrap valign="top"> time_t userrec::signon
1061 <table cellspacing=5 cellpadding=0 border=0>
1069 The users signon time.
1073 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>.
1075 Referenced by <a class="el" href="users_8cpp-source.html#l00026">userrec()</a>. </td>
1078 <hr>The documentation for this class was generated from the following files:<ul>
1079 <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>
1080 <hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by
1081 <a href="http://www.doxygen.org/index.html">
1082 <img src="doxygen.png" alt="doxygen" align="middle" border=0
1083 width=110 height=53></a>1.3-rc2 </small></address>