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