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>InspIRCd: userrec class Reference</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3.3 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</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></div>
8 <h1>userrec Class Reference</h1>Holds all information about a user This class stores all information about a user connected to the irc server.
9 <a href="#_details">More...</a>
11 <code>#include <<a class="el" href="users_8h-source.html">users.h</a>></code>
13 Inheritance diagram for userrec:<p><center><img src="classuserrec__inherit__graph.gif" border="0" usemap="#userrec__inherit__map" alt="Inheritance graph"></center>
14 <map name="userrec__inherit__map">
15 <area href="classconnection.html" shape="rect" coords="7,157,93,184" alt="">
16 <area href="classExtensible.html" shape="rect" coords="9,82,91,109" alt="">
17 <area href="classclassbase.html" shape="rect" coords="10,8,90,34" alt="">
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="199,469,285,496" alt="">
22 <area href="classucrec.html" shape="rect" coords="215,237,269,264" alt="">
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>
26 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
27 <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a0">userrec</a> ()</td></tr>
29 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a1">~userrec</a> ()</td></tr>
31 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual char * </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a2">GetFullHost</a> ()</td></tr>
33 <tr><td class="mdescLeft"> </td><td class="mdescRight">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><br><br></td></tr>
34 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual char * </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a3">GetFullRealHost</a> ()</td></tr>
36 <tr><td class="mdescLeft"> </td><td class="mdescRight">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><br><br></td></tr>
37 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a4">IsInvited</a> (char *channel)</td></tr>
39 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a user is invited to a channel. </em> <a href="#a4"></a><em><br><br></td></tr>
40 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a5">InviteTo</a> (char *channel)</td></tr>
42 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a channel to a users invite list (invites them to a channel). </em> <a href="#a5"></a><em><br><br></td></tr>
43 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a6">RemoveInvite</a> (char *channel)</td></tr>
45 <tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a channel from a users invite list. </em> <a href="#a6"></a><em><br><br></td></tr>
46 <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a7">HasPermission</a> (char *command)</td></tr>
48 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true or false for if a user can execute a privilaged oper command. </em> <a href="#a7"></a><em><br><br></td></tr>
49 <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a8">AddBuffer</a> (std::string a)</td></tr>
51 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method adds data to the buffer of the user. </em> <a href="#a8"></a><em><br><br></td></tr>
52 <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a9">BufferIsReady</a> ()</td></tr>
54 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns true if the buffer contains at least one carriage return character (e.g. </em> <a href="#a9"></a><em><br><br></td></tr>
55 <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a10">ClearBuffer</a> ()</td></tr>
57 <tr><td class="mdescLeft"> </td><td class="mdescRight">This function clears the entire buffer by setting it to an empty string. </em> <a href="#a10"></a><em><br><br></td></tr>
58 <tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a11">GetBuffer</a> ()</td></tr>
60 <tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string. </em> <a href="#a11"></a><em><br><br></td></tr>
61 <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a12">SetWriteError</a> (std::string error)</td></tr>
63 <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the write error for a connection. </em> <a href="#a12"></a><em><br><br></td></tr>
64 <tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a13">GetWriteError</a> ()</td></tr>
66 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the write error which last occured on this connection or an empty string if none occured. </em> <a href="#a13"></a><em><br><br></td></tr>
67 <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a14">AddWriteBuf</a> (std::string data)</td></tr>
69 <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds to the user's write buffer. </em> <a href="#a14"></a><em><br><br></td></tr>
70 <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#a15">FlushWriteBuf</a> ()</td></tr>
72 <tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes as much of the user's buffer to the file descriptor as possible. </em> <a href="#a15"></a><em><br><br></td></tr>
73 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
74 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o0">nick</a> [NICKMAX]</td></tr>
76 <tr><td class="mdescLeft"> </td><td class="mdescRight">The users nickname. </em> <a href="#o0"></a><em><br><br></td></tr>
77 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o1">ident</a> [16]</td></tr>
79 <tr><td class="mdescLeft"> </td><td class="mdescRight">The users ident reply. </em> <a href="#o1"></a><em><br><br></td></tr>
80 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o2">dhost</a> [160]</td></tr>
82 <tr><td class="mdescLeft"> </td><td class="mdescRight">The host displayed to non-opers (used for cloaking etc). </em> <a href="#o2"></a><em><br><br></td></tr>
83 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o3">fullname</a> [128]</td></tr>
85 <tr><td class="mdescLeft"> </td><td class="mdescRight">The users full name. </em> <a href="#o3"></a><em><br><br></td></tr>
86 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o4">modes</a> [MAXBUF]</td></tr>
88 <tr><td class="mdescLeft"> </td><td class="mdescRight">The user's mode string. </em> <a href="#o4"></a><em><br><br></td></tr>
89 <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classucrec.html">ucrec</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o5">chans</a> [MAXCHANS]</td></tr>
91 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o6">server</a> [256]</td></tr>
93 <tr><td class="mdescLeft"> </td><td class="mdescRight">The server the user is connected to. </em> <a href="#o6"></a><em><br><br></td></tr>
94 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o7">awaymsg</a> [512]</td></tr>
96 <tr><td class="mdescLeft"> </td><td class="mdescRight">The user's away message. </em> <a href="#o7"></a><em><br><br></td></tr>
97 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o8">result</a> [256]</td></tr>
99 <tr><td class="mdescLeft"> </td><td class="mdescRight">Stores the result of the last GetFullHost or GetRealHost call. </em> <a href="#o8"></a><em><br><br></td></tr>
100 <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o9">flood</a></td></tr>
102 <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. </em> <a href="#o9"></a><em><br><br></td></tr>
103 <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o10">timeout</a></td></tr>
105 <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. </em> <a href="#o10"></a><em><br><br></td></tr>
106 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o11">oper</a> [NICKMAX]</td></tr>
108 <tr><td class="mdescLeft"> </td><td class="mdescRight">The oper type they logged in as, if they are an oper. </em> <a href="#o11"></a><em><br><br></td></tr>
109 <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o12">dns_done</a></td></tr>
111 <tr><td class="mdescLeft"> </td><td class="mdescRight">True when <a class="el" href="classDNS.html">DNS</a> lookups are completed. </em> <a href="#o12"></a><em><br><br></td></tr>
112 <tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o13">pingmax</a></td></tr>
114 <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of seconds between PINGs for this user (set from <connect:allow> tag. </em> <a href="#o13"></a><em><br><br></td></tr>
115 <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o14">password</a> [MAXBUF]</td></tr>
117 <tr><td class="mdescLeft"> </td><td class="mdescRight">Password specified by the user when they registered. </em> <a href="#o14"></a><em><br><br></td></tr>
118 <tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o15">recvq</a></td></tr>
120 <tr><td class="mdescLeft"> </td><td class="mdescRight">User's receive queue. </em> <a href="#o15"></a><em><br><br></td></tr>
121 <tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o16">sendq</a></td></tr>
123 <tr><td class="mdescLeft"> </td><td class="mdescRight">User's send queue. </em> <a href="#o16"></a><em><br><br></td></tr>
124 <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o17">lines_in</a></td></tr>
126 <tr><td class="mdescLeft"> </td><td class="mdescRight">Flood counters. </em> <a href="#o17"></a><em><br><br></td></tr>
127 <tr><td class="memItemLeft" nowrap align=right valign=top>time_t </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o18">reset_due</a></td></tr>
129 <tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o19">threshold</a></td></tr>
131 <tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o20">WriteError</a></td></tr>
133 <tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o21">sendqmax</a></td></tr>
135 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size this user's sendq can become. </em> <a href="#o21"></a><em><br><br></td></tr>
136 <tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o22">recvqmax</a></td></tr>
138 <tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum size this user's recvq can become. </em> <a href="#o22"></a><em><br><br></td></tr>
139 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
140 <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="users_8h.html#a6">InvitedList</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#r0">invites</a></td></tr>
142 <tr><td class="mdescLeft"> </td><td class="mdescRight">A list of channels the user has a pending invite to. </em> <a href="#r0"></a><em><br><br></td></tr>
144 <hr><a name="_details"></a><h2>Detailed Description</h2>
145 Holds all information about a user This class stores all information about a user connected to the irc server.
147 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.
151 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>.<hr><h2>Constructor & Destructor Documentation</h2>
152 <a name="a0" doxytag="userrec::userrec"></a><p>
153 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
156 <table cellpadding="0" cellspacing="0" border="0">
158 <td class="md" nowrap valign="top"> userrec::userrec </td>
159 <td class="md" valign="top">( </td>
160 <td class="mdname1" valign="top" nowrap> </td>
161 <td class="md" valign="top"> ) </td>
162 <td class="md" nowrap></td>
169 <table cellspacing=5 cellpadding=0 border=0>
179 Definition at line <a class="el" href="users_8cpp-source.html#l00028">28</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
181 References <a class="el" href="users_8h-source.html#l00151">awaymsg</a>, <a class="el" href="connection_8h-source.html#l00227">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00231">connection::bytes_out</a>, <a class="el" href="channels_8h-source.html#l00233">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00142">chans</a>, <a class="el" href="connection_8h-source.html#l00235">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00239">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00130">dhost</a>, <a class="el" href="users_8h-source.html#l00179">dns_done</a>, <a class="el" href="connection_8h-source.html#l00215">connection::fd</a>, <a class="el" href="users_8h-source.html#l00162">flood</a>, <a class="el" href="users_8h-source.html#l00134">fullname</a>, <a class="el" href="connection_8h-source.html#l00243">connection::haspassed</a>, <a class="el" href="connection_8h-source.html#l00219">connection::host</a>, <a class="el" href="users_8h-source.html#l00125">ident</a>, <a class="el" href="connection_8h-source.html#l00265">connection::idle_lastmsg</a>, <a class="el" href="users_8h-source.html#l00114">invites</a>, <a class="el" href="connection_8h-source.html#l00223">connection::ip</a>, <a class="el" href="connection_8h-source.html#l00257">connection::lastping</a>, <a class="el" href="users_8h-source.html#l00204">lines_in</a>, <a class="el" href="users_8h-source.html#l00140">modes</a>, <a class="el" href="users_8h-source.html#l00121">nick</a>, <a class="el" href="connection_8h-source.html#l00269">connection::nping</a>, <a class="el" href="users_8h-source.html#l00175">oper</a>, <a class="el" href="connection_8h-source.html#l00249">connection::port</a>, <a class="el" href="users_8h-source.html#l00195">recvq</a>, <a class="el" href="connection_8h-source.html#l00253">connection::registered</a>, <a class="el" href="users_8h-source.html#l00205">reset_due</a>, <a class="el" href="users_8h-source.html#l00156">result</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, <a class="el" href="users_8h-source.html#l00146">server</a>, <a class="el" href="connection_8h-source.html#l00261">connection::signon</a>, <a class="el" href="channels_8cpp-source.html#l00107">TIME</a>, <a class="el" href="users_8h-source.html#l00168">timeout</a>, and <a class="el" href="channels_8h-source.html#l00228">ucrec::uc_modes</a>.
183 <div class="fragment"><pre>00029 {
184 00030 <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span>
185 00031 strcpy(nick,<span class="stringliteral">""</span>);
186 00032 strcpy(ip,<span class="stringliteral">"127.0.0.1"</span>);
187 00033 <a class="code" href="classuserrec.html#o10">timeout</a> = 0;
188 00034 strcpy(ident,<span class="stringliteral">""</span>);
189 00035 strcpy(host,<span class="stringliteral">""</span>);
190 00036 strcpy(dhost,<span class="stringliteral">""</span>);
191 00037 strcpy(fullname,<span class="stringliteral">""</span>);
192 00038 strcpy(modes,<span class="stringliteral">""</span>);
193 00039 strcpy(server,<span class="stringliteral">""</span>);
194 00040 strcpy(awaymsg,<span class="stringliteral">""</span>);
195 00041 strcpy(oper,<span class="stringliteral">""</span>);
196 00042 <a class="code" href="classuserrec.html#o18">reset_due</a> = <a class="code" href="channels_8cpp.html#a37">TIME</a>;
197 00043 <a class="code" href="classuserrec.html#o17">lines_in</a> = 0;
198 00044 <a class="code" href="classconnection.html#o0">fd</a> = <a class="code" href="classconnection.html#o10">lastping</a> = <a class="code" href="classconnection.html#o11">signon</a> = <a class="code" href="classconnection.html#o12">idle_lastmsg</a> = <a class="code" href="classconnection.html#o13">nping</a> = <a class="code" href="classconnection.html#o9">registered</a> = 0;
199 00045 <a class="code" href="classuserrec.html#o9">flood</a> = <a class="code" href="classconnection.html#o8">port</a> = <a class="code" href="classconnection.html#o3">bytes_in</a> = <a class="code" href="classconnection.html#o4">bytes_out</a> = <a class="code" href="classconnection.html#o5">cmds_in</a> = <a class="code" href="classconnection.html#o6">cmds_out</a> = 0;
200 00046 <a class="code" href="classconnection.html#o7">haspassed</a> = <span class="keyword">false</span>;
201 00047 <a class="code" href="classuserrec.html#o12">dns_done</a> = <span class="keyword">false</span>;
202 00048 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>;
203 00049 <a class="code" href="classuserrec.html#o16">sendq</a> = <span class="stringliteral">""</span>;
204 00050 strcpy(result,<span class="stringliteral">""</span>);
205 00051 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < MAXCHANS; i++)
207 00053 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o1">channel</a> = NULL;
208 00054 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o0">uc_modes</a> = 0;
210 00056 <a class="code" href="classuserrec.html#r0">invites</a>.clear();
215 <a name="a1" doxytag="userrec::~userrec"></a><p>
216 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
219 <table cellpadding="0" cellspacing="0" border="0">
221 <td class="md" nowrap valign="top"> virtual userrec::~<a class="el" href="classuserrec.html">userrec</a> </td>
222 <td class="md" valign="top">( </td>
223 <td class="mdname1" valign="top" nowrap> </td>
224 <td class="md" valign="top"> ) </td>
225 <td class="md" nowrap><code> [inline, virtual]</code></td>
232 <table cellspacing=5 cellpadding=0 border=0>
242 Definition at line <a class="el" href="users_8h-source.html#l00222">222</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
244 <div class="fragment"><pre>00222 { }
248 <hr><h2>Member Function Documentation</h2>
249 <a name="a8" doxytag="userrec::AddBuffer"></a><p>
250 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
253 <table cellpadding="0" cellspacing="0" border="0">
255 <td class="md" nowrap valign="top"> bool userrec::AddBuffer </td>
256 <td class="md" valign="top">( </td>
257 <td class="md" nowrap valign="top">std::string </td>
258 <td class="mdname1" valign="top" nowrap> <em>a</em> </td>
259 <td class="md" valign="top"> ) </td>
260 <td class="md" nowrap></td>
267 <table cellspacing=5 cellpadding=0 border=0>
275 This method adds data to the buffer of the user.
277 The buffer can grow to any size within limits of the available memory, managed by the size of a std::string, however if any individual line in the buffer grows over 600 bytes in length (which is 88 chars over the RFC-specified limit per line) then the method will return false and the text will not be inserted.
279 Definition at line <a class="el" href="users_8cpp-source.html#l00169">169</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
281 References <a class="el" href="users_8h-source.html#l00195">recvq</a>, <a class="el" href="users_8h-source.html#l00218">recvqmax</a>, and <a class="el" href="users_8cpp-source.html#l00263">SetWriteError()</a>.
283 <div class="fragment"><pre>00170 {
284 00171 std::string b = <span class="stringliteral">""</span>;
285 00172 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < a.length(); i++)
286 00173 <span class="keywordflow">if</span> ((a[i] != <span class="charliteral">'\r'</span>) && (a[i] != <span class="charliteral">'\0'</span>) && (a[i] != 7))
288 00175 std::stringstream stream(recvq);
289 00176 stream << b;
290 00177 <a class="code" href="classuserrec.html#o15">recvq</a> = stream.str();
291 00178 <span class="keywordtype">int</span> i = 0;
292 00179 <span class="comment">// count the size of the first line in the buffer.</span>
293 00180 <span class="keywordflow">while</span> (i < <a class="code" href="classuserrec.html#o15">recvq</a>.length())
295 00182 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i++] == <span class="charliteral">'\n'</span>)
296 00183 <span class="keywordflow">break</span>;
298 00185 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>.length() > this-><a class="code" href="classuserrec.html#o22">recvqmax</a>)
300 00187 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(<span class="stringliteral">"RecvQ exceeded"</span>);
301 00188 WriteOpers(<span class="stringliteral">"*** User %s RecvQ of %d exceeds connect class maximum of %d"</span>,this->nick,<a class="code" href="classuserrec.html#o15">recvq</a>.length(),this-><a class="code" href="classuserrec.html#o22">recvqmax</a>);
303 00190 <span class="comment">// return false if we've had more than 600 characters WITHOUT</span>
304 00191 <span class="comment">// a carriage return (this is BAD, drop the socket)</span>
305 00192 <span class="keywordflow">return</span> (i < 600);
310 <a name="a14" doxytag="userrec::AddWriteBuf"></a><p>
311 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
314 <table cellpadding="0" cellspacing="0" border="0">
316 <td class="md" nowrap valign="top"> void userrec::AddWriteBuf </td>
317 <td class="md" valign="top">( </td>
318 <td class="md" nowrap valign="top">std::string </td>
319 <td class="mdname1" valign="top" nowrap> <em>data</em> </td>
320 <td class="md" valign="top"> ) </td>
321 <td class="md" nowrap></td>
328 <table cellspacing=5 cellpadding=0 border=0>
336 Adds to the user's write buffer.
338 You may add any amount of text up to this users sendq value, if you exceed the sendq value, <a class="el" href="classuserrec.html#a12">SetWriteError()</a> will be called to set the users error string to "SendQ exceeded", and further buffer adds will be dropped.
340 Definition at line <a class="el" href="users_8cpp-source.html#l00225">225</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
342 References <a class="el" href="users_8cpp-source.html#l00271">GetWriteError()</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, <a class="el" href="users_8h-source.html#l00214">sendqmax</a>, and <a class="el" href="users_8cpp-source.html#l00263">SetWriteError()</a>.
344 <div class="fragment"><pre>00226 {
345 00227 <span class="keywordflow">if</span> (this-><a class="code" href="classuserrec.html#a13">GetWriteError</a>() != <span class="stringliteral">""</span>)
346 00228 <span class="keywordflow">return</span>;
347 00229 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o16">sendq</a>.length() + data.length() > this-><a class="code" href="classuserrec.html#o21">sendqmax</a>)
349 00231 WriteOpers(<span class="stringliteral">"*** User %s SendQ of %d exceeds connect class maximum of %d"</span>,this->nick,<a class="code" href="classuserrec.html#o16">sendq</a>.length() + data.length(),this-><a class="code" href="classuserrec.html#o21">sendqmax</a>);
350 00232 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(<span class="stringliteral">"SendQ exceeded"</span>);
351 00233 <span class="keywordflow">return</span>;
353 00235 std::stringstream stream;
354 00236 stream << <a class="code" href="classuserrec.html#o16">sendq</a> << data;
355 00237 <a class="code" href="classuserrec.html#o16">sendq</a> = stream.str();
360 <a name="a9" doxytag="userrec::BufferIsReady"></a><p>
361 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
364 <table cellpadding="0" cellspacing="0" border="0">
366 <td class="md" nowrap valign="top"> bool userrec::BufferIsReady </td>
367 <td class="md" valign="top">( </td>
368 <td class="mdname1" valign="top" nowrap> </td>
369 <td class="md" valign="top"> ) </td>
370 <td class="md" nowrap></td>
377 <table cellspacing=5 cellpadding=0 border=0>
385 This method returns true if the buffer contains at least one carriage return character (e.g.
387 one complete line may be read)
389 Definition at line <a class="el" href="users_8cpp-source.html#l00195">195</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
391 References <a class="el" href="users_8h-source.html#l00195">recvq</a>.
393 <div class="fragment"><pre>00196 {
394 00197 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="classuserrec.html#o15">recvq</a>.length(); i++)
395 00198 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i] == <span class="charliteral">'\n'</span>)
396 00199 <span class="keywordflow">return</span> <span class="keyword">true</span>;
397 00200 <span class="keywordflow">return</span> <span class="keyword">false</span>;
402 <a name="a10" doxytag="userrec::ClearBuffer"></a><p>
403 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
406 <table cellpadding="0" cellspacing="0" border="0">
408 <td class="md" nowrap valign="top"> void userrec::ClearBuffer </td>
409 <td class="md" valign="top">( </td>
410 <td class="mdname1" valign="top" nowrap> </td>
411 <td class="md" valign="top"> ) </td>
412 <td class="md" nowrap></td>
419 <table cellspacing=5 cellpadding=0 border=0>
427 This function clears the entire buffer by setting it to an empty string.
431 Definition at line <a class="el" href="users_8cpp-source.html#l00203">203</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
433 References <a class="el" href="users_8h-source.html#l00195">recvq</a>.
435 Referenced by <a class="el" href="modules_8cpp-source.html#l00700">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::UserToPseudo()</a>.
437 <div class="fragment"><pre>00204 {
438 00205 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>;
443 <a name="a15" doxytag="userrec::FlushWriteBuf"></a><p>
444 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
447 <table cellpadding="0" cellspacing="0" border="0">
449 <td class="md" nowrap valign="top"> void userrec::FlushWriteBuf </td>
450 <td class="md" valign="top">( </td>
451 <td class="mdname1" valign="top" nowrap> </td>
452 <td class="md" valign="top"> ) </td>
453 <td class="md" nowrap></td>
460 <table cellspacing=5 cellpadding=0 border=0>
468 Flushes as much of the user's buffer to the file descriptor as possible.
470 This function may not always flush the entire buffer, rather instead as much of it as it possibly can. If the send() call fails to send the entire buffer, the buffer position is advanced forwards and the rest of the data sent at the next call to this method.
472 Definition at line <a class="el" href="users_8cpp-source.html#l00241">241</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
474 References <a class="el" href="connection_8h-source.html#l00231">connection::bytes_out</a>, <a class="el" href="connection_8h-source.html#l00239">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, and <a class="el" href="users_8cpp-source.html#l00263">SetWriteError()</a>.
476 <div class="fragment"><pre>00242 {
477 00243 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o16">sendq</a>.length())
479 00245 <span class="keywordtype">char</span>* tb = (<span class="keywordtype">char</span>*)this-><a class="code" href="classuserrec.html#o16">sendq</a>.c_str();
480 00246 <span class="keywordtype">int</span> n_sent = write(this->fd,tb,this->sendq.length());
481 00247 <span class="keywordflow">if</span> (n_sent == -1)
483 00249 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(strerror(errno));
485 00251 <span class="keywordflow">else</span>
487 00253 <span class="comment">// advance the queue</span>
489 00255 this-><a class="code" href="classuserrec.html#o16">sendq</a> = tb;
490 00256 <span class="comment">// update the user's stats counters</span>
491 00257 this-><a class="code" href="classconnection.html#o4">bytes_out</a> += n_sent;
492 00258 this-><a class="code" href="classconnection.html#o6">cmds_out</a>++;
499 <a name="a11" doxytag="userrec::GetBuffer"></a><p>
500 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
503 <table cellpadding="0" cellspacing="0" border="0">
505 <td class="md" nowrap valign="top"> std::string userrec::GetBuffer </td>
506 <td class="md" valign="top">( </td>
507 <td class="mdname1" valign="top" nowrap> </td>
508 <td class="md" valign="top"> ) </td>
509 <td class="md" nowrap></td>
516 <table cellspacing=5 cellpadding=0 border=0>
524 This method returns the first available string at the tail end of the buffer and advances the tail end of the buffer past the string.
526 This means it is a one way operation in a similar way to strtok(), and multiple calls return multiple lines if they are available. The results of this function if there are no lines to be read are unknown, always use <a class="el" href="classuserrec.html#a9">BufferIsReady()</a> to check if it is ok to read the buffer before calling <a class="el" href="classuserrec.html#a11">GetBuffer()</a>.
528 Definition at line <a class="el" href="users_8cpp-source.html#l00208">208</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
530 References <a class="el" href="users_8h-source.html#l00195">recvq</a>.
532 <div class="fragment"><pre>00209 {
533 00210 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a> == <span class="stringliteral">""</span>)
534 00211 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
535 00212 <span class="keywordtype">char</span>* line = (<span class="keywordtype">char</span>*)<a class="code" href="classuserrec.html#o15">recvq</a>.c_str();
536 00213 std::string ret = <span class="stringliteral">""</span>;
537 00214 <span class="keywordflow">while</span> ((*line != <span class="charliteral">'\n'</span>) && (strlen(line)))
539 00216 ret = ret + *line;
542 00219 <span class="keywordflow">if</span> ((*line == <span class="charliteral">'\n'</span>) || (*line == <span class="charliteral">'\r'</span>))
544 00221 <a class="code" href="classuserrec.html#o15">recvq</a> = line;
545 00222 <span class="keywordflow">return</span> ret;
550 <a name="a2" doxytag="userrec::GetFullHost"></a><p>
551 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
554 <table cellpadding="0" cellspacing="0" border="0">
556 <td class="md" nowrap valign="top"> char * userrec::GetFullHost </td>
557 <td class="md" valign="top">( </td>
558 <td class="mdname1" valign="top" nowrap> </td>
559 <td class="md" valign="top"> ) </td>
560 <td class="md" nowrap><code> [virtual]</code></td>
567 <table cellspacing=5 cellpadding=0 border=0>
575 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.
579 Definition at line <a class="el" href="users_8cpp-source.html#l00061">61</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
581 References <a class="el" href="users_8h-source.html#l00130">dhost</a>, <a class="el" href="users_8h-source.html#l00125">ident</a>, <a class="el" href="users_8h-source.html#l00121">nick</a>, and <a class="el" href="users_8h-source.html#l00156">result</a>.
583 <div class="fragment"><pre>00062 {
584 00063 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost);
585 00064 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>;
590 <a name="a3" doxytag="userrec::GetFullRealHost"></a><p>
591 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
594 <table cellpadding="0" cellspacing="0" border="0">
596 <td class="md" nowrap valign="top"> char * userrec::GetFullRealHost </td>
597 <td class="md" valign="top">( </td>
598 <td class="mdname1" valign="top" nowrap> </td>
599 <td class="md" valign="top"> ) </td>
600 <td class="md" nowrap><code> [virtual]</code></td>
607 <table cellspacing=5 cellpadding=0 border=0>
615 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.
617 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.
619 Definition at line <a class="el" href="users_8cpp-source.html#l00068">68</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
621 References <a class="el" href="connection_8h-source.html#l00219">connection::host</a>, <a class="el" href="users_8h-source.html#l00125">ident</a>, <a class="el" href="users_8h-source.html#l00121">nick</a>, and <a class="el" href="users_8h-source.html#l00156">result</a>.
623 <div class="fragment"><pre>00069 {
624 00070 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host);
625 00071 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>;
630 <a name="a13" doxytag="userrec::GetWriteError"></a><p>
631 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
634 <table cellpadding="0" cellspacing="0" border="0">
636 <td class="md" nowrap valign="top"> std::string userrec::GetWriteError </td>
637 <td class="md" valign="top">( </td>
638 <td class="mdname1" valign="top" nowrap> </td>
639 <td class="md" valign="top"> ) </td>
640 <td class="md" nowrap></td>
647 <table cellspacing=5 cellpadding=0 border=0>
655 Returns the write error which last occured on this connection or an empty string if none occured.
659 Definition at line <a class="el" href="users_8cpp-source.html#l00271">271</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
661 References <a class="el" href="users_8h-source.html#l00210">WriteError</a>.
663 Referenced by <a class="el" href="users_8cpp-source.html#l00225">AddWriteBuf()</a>.
665 <div class="fragment"><pre>00272 {
666 00273 <span class="keywordflow">return</span> this-><a class="code" href="classuserrec.html#o20">WriteError</a>;
671 <a name="a7" doxytag="userrec::HasPermission"></a><p>
672 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
675 <table cellpadding="0" cellspacing="0" border="0">
677 <td class="md" nowrap valign="top"> bool userrec::HasPermission </td>
678 <td class="md" valign="top">( </td>
679 <td class="md" nowrap valign="top">char * </td>
680 <td class="mdname1" valign="top" nowrap> <em>command</em> </td>
681 <td class="md" valign="top"> ) </td>
682 <td class="md" nowrap></td>
689 <table cellspacing=5 cellpadding=0 border=0>
697 Returns true or false for if a user can execute a privilaged oper command.
699 This is done by looking up their oper type from <a class="el" href="classuserrec.html#o11">userrec::oper</a>, then referencing this to their oper classes and checking the commands they can execute.
701 Definition at line <a class="el" href="users_8cpp-source.html#l00117">117</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
703 References <a class="el" href="channels_8cpp-source.html#l00101">config_f</a>, and <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>.
705 <div class="fragment"><pre>00118 {
706 00119 <span class="keywordtype">char</span> TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF];
707 00120 <span class="keywordtype">char</span>* mycmd;
708 00121 <span class="keywordtype">char</span>* savept;
709 00122 <span class="keywordtype">char</span>* savept2;
711 00124 <span class="comment">// are they even an oper at all?</span>
712 00125 <span class="keywordflow">if</span> (strchr(this->modes,<span class="charliteral">'o'</span>))
714 00127 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper"</span>,this->nick);
715 00128 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j =0; j < ConfValueEnum(<span class="stringliteral">"type"</span>,&config_f); j++)
717 00130 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"name"</span>,j,TypeName,&config_f);
718 00131 <span class="keywordflow">if</span> (!strcmp(TypeName,this->oper))
720 00133 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper of type '%s'"</span>,this->nick,this->oper);
721 00134 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"classes"</span>,j,Classes,&config_f);
722 00135 <span class="keywordtype">char</span>* myclass = strtok_r(Classes,<span class="stringliteral">" "</span>,&savept);
723 00136 <span class="keywordflow">while</span> (myclass)
725 00138 log(DEBUG,<span class="stringliteral">"*** HasPermission: checking classtype '%s'"</span>,myclass);
726 00139 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> k =0; k < ConfValueEnum(<span class="stringliteral">"class"</span>,&config_f); k++)
728 00141 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"name"</span>,k,ClassName,&config_f);
729 00142 <span class="keywordflow">if</span> (!strcmp(ClassName,myclass))
731 00144 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"commands"</span>,k,CommandList,&config_f);
732 00145 log(DEBUG,<span class="stringliteral">"*** HasPermission: found class named %s with commands: '%s'"</span>,ClassName,CommandList);
735 00148 mycmd = strtok_r(CommandList,<span class="stringliteral">" "</span>,&savept2);
736 00149 <span class="keywordflow">while</span> (mycmd)
738 00151 <span class="keywordflow">if</span> (!strcasecmp(mycmd,command))
740 00153 log(DEBUG,<span class="stringliteral">"*** Command %s found, returning true"</span>,command);
741 00154 <span class="keywordflow">return</span> <span class="keyword">true</span>;
743 00156 mycmd = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept2);
747 00160 myclass = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept);
752 00165 <span class="keywordflow">return</span> <span class="keyword">false</span>;
757 <a name="a5" doxytag="userrec::InviteTo"></a><p>
758 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
761 <table cellpadding="0" cellspacing="0" border="0">
763 <td class="md" nowrap valign="top"> void userrec::InviteTo </td>
764 <td class="md" valign="top">( </td>
765 <td class="md" nowrap valign="top">char * </td>
766 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
767 <td class="md" valign="top"> ) </td>
768 <td class="md" nowrap><code> [virtual]</code></td>
775 <table cellspacing=5 cellpadding=0 border=0>
783 Adds a channel to a users invite list (invites them to a channel).
787 Definition at line <a class="el" href="users_8cpp-source.html#l00088">88</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
789 References <a class="el" href="users_8h-source.html#l00039">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00114">invites</a>.
791 <div class="fragment"><pre>00089 {
792 00090 <a class="code" href="classInvited.html">Invited</a> i;
793 00091 strlcpy(i.<a class="code" href="classInvited.html#o0">channel</a>,channel,CHANMAX);
794 00092 <a class="code" href="classuserrec.html#r0">invites</a>.push_back(i);
799 <a name="a4" doxytag="userrec::IsInvited"></a><p>
800 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
803 <table cellpadding="0" cellspacing="0" border="0">
805 <td class="md" nowrap valign="top"> bool userrec::IsInvited </td>
806 <td class="md" valign="top">( </td>
807 <td class="md" nowrap valign="top">char * </td>
808 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
809 <td class="md" valign="top"> ) </td>
810 <td class="md" nowrap><code> [virtual]</code></td>
817 <table cellspacing=5 cellpadding=0 border=0>
825 Returns true if a user is invited to a channel.
829 Definition at line <a class="el" href="users_8cpp-source.html#l00074">74</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
831 References <a class="el" href="users_8h-source.html#l00114">invites</a>.
833 <div class="fragment"><pre>00075 {
834 00076 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#r0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#r0">invites</a>.end(); i++)
836 00078 <span class="keywordflow">if</span> (i->channel) {
837 00079 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel))
839 00081 <span class="keywordflow">return</span> <span class="keyword">true</span>;
843 00085 <span class="keywordflow">return</span> <span class="keyword">false</span>;
848 <a name="a6" doxytag="userrec::RemoveInvite"></a><p>
849 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
852 <table cellpadding="0" cellspacing="0" border="0">
854 <td class="md" nowrap valign="top"> void userrec::RemoveInvite </td>
855 <td class="md" valign="top">( </td>
856 <td class="md" nowrap valign="top">char * </td>
857 <td class="mdname1" valign="top" nowrap> <em>channel</em> </td>
858 <td class="md" valign="top"> ) </td>
859 <td class="md" nowrap><code> [virtual]</code></td>
866 <table cellspacing=5 cellpadding=0 border=0>
874 Removes a channel from a users invite list.
876 This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.
878 Definition at line <a class="el" href="users_8cpp-source.html#l00095">95</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
880 References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00114">invites</a>.
882 <div class="fragment"><pre>00096 {
883 00097 log(DEBUG,<span class="stringliteral">"Removing invites"</span>);
884 00098 <span class="keywordflow">if</span> (channel)
886 00100 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#r0">invites</a>.size())
888 00102 <span class="keywordflow">for</span> (InvitedList::iterator i = <a class="code" href="classuserrec.html#r0">invites</a>.begin(); i != <a class="code" href="classuserrec.html#r0">invites</a>.end(); i++)
890 00104 <span class="keywordflow">if</span> (i->channel)
892 00106 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel))
894 00108 <a class="code" href="classuserrec.html#r0">invites</a>.erase(i);
895 00109 <span class="keywordflow">return</span>;
905 <a name="a12" doxytag="userrec::SetWriteError"></a><p>
906 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
909 <table cellpadding="0" cellspacing="0" border="0">
911 <td class="md" nowrap valign="top"> void userrec::SetWriteError </td>
912 <td class="md" valign="top">( </td>
913 <td class="md" nowrap valign="top">std::string </td>
914 <td class="mdname1" valign="top" nowrap> <em>error</em> </td>
915 <td class="md" valign="top"> ) </td>
916 <td class="md" nowrap></td>
923 <table cellspacing=5 cellpadding=0 border=0>
931 Sets the write error for a connection.
933 This is done because the actual disconnect of a client may occur at an inopportune time such as half way through /LIST output. The WriteErrors of clients are checked at a more ideal time (in the mainloop) and errored clients purged.
935 Definition at line <a class="el" href="users_8cpp-source.html#l00263">263</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>.
937 References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00210">WriteError</a>.
939 Referenced by <a class="el" href="users_8cpp-source.html#l00169">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00225">AddWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00241">FlushWriteBuf()</a>.
941 <div class="fragment"><pre>00264 {
942 00265 log(DEBUG,<span class="stringliteral">"Setting error string for %s to '%s'"</span>,this->nick,error.c_str());
943 00266 <span class="comment">// don't try to set the error twice, its already set take the first string.</span>
944 00267 <span class="keywordflow">if</span> (this-><a class="code" href="classuserrec.html#o20">WriteError</a> == <span class="stringliteral">""</span>)
945 00268 this-><a class="code" href="classuserrec.html#o20">WriteError</a> = error;
950 <hr><h2>Member Data Documentation</h2>
951 <a name="o7" doxytag="userrec::awaymsg"></a><p>
952 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
955 <table cellpadding="0" cellspacing="0" border="0">
957 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o7">userrec::awaymsg</a>[512]
962 <table cellspacing=5 cellpadding=0 border=0>
970 The user's away message.
972 If this string is empty, the user is not marked as away.
974 Definition at line <a class="el" href="users_8h-source.html#l00151">151</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
976 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
979 <a name="o5" doxytag="userrec::chans"></a><p>
980 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
983 <table cellpadding="0" cellspacing="0" border="0">
985 <td class="md" nowrap valign="top"> <a class="el" href="classucrec.html">ucrec</a> <a class="el" href="classuserrec.html#o5">userrec::chans</a>[MAXCHANS]
990 <table cellspacing=5 cellpadding=0 border=0>
1000 Definition at line <a class="el" href="users_8h-source.html#l00142">142</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1002 Referenced by <a class="el" href="modules_8cpp-source.html#l00700">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1005 <a name="o2" doxytag="userrec::dhost"></a><p>
1006 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1009 <table cellpadding="0" cellspacing="0" border="0">
1011 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o2">userrec::dhost</a>[160]
1016 <table cellspacing=5 cellpadding=0 border=0>
1024 The host displayed to non-opers (used for cloaking etc).
1026 This usually matches the value of <a class="el" href="classconnection.html#o1">userrec::host</a>.
1028 Definition at line <a class="el" href="users_8h-source.html#l00130">130</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1030 Referenced by <a class="el" href="users_8cpp-source.html#l00061">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1033 <a name="o12" doxytag="userrec::dns_done"></a><p>
1034 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1037 <table cellpadding="0" cellspacing="0" border="0">
1039 <td class="md" nowrap valign="top"> bool <a class="el" href="classuserrec.html#o12">userrec::dns_done</a>
1044 <table cellspacing=5 cellpadding=0 border=0>
1052 True when <a class="el" href="classDNS.html">DNS</a> lookups are completed.
1056 Definition at line <a class="el" href="users_8h-source.html#l00179">179</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1058 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1061 <a name="o9" doxytag="userrec::flood"></a><p>
1062 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1065 <table cellpadding="0" cellspacing="0" border="0">
1067 <td class="md" nowrap valign="top"> int <a class="el" href="classuserrec.html#o9">userrec::flood</a>
1072 <table cellspacing=5 cellpadding=0 border=0>
1080 Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood.
1084 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>.
1086 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1089 <a name="o3" doxytag="userrec::fullname"></a><p>
1090 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1093 <table cellpadding="0" cellspacing="0" border="0">
1095 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o3">userrec::fullname</a>[128]
1100 <table cellspacing=5 cellpadding=0 border=0>
1108 The users full name.
1112 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>.
1114 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1117 <a name="o1" doxytag="userrec::ident"></a><p>
1118 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1121 <table cellpadding="0" cellspacing="0" border="0">
1123 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o1">userrec::ident</a>[16]
1128 <table cellspacing=5 cellpadding=0 border=0>
1136 The users ident reply.
1140 Definition at line <a class="el" href="users_8h-source.html#l00125">125</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1142 Referenced by <a class="el" href="users_8cpp-source.html#l00061">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00068">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00700">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00681">Server::UserToPseudo()</a>. </td>
1145 <a name="r0" doxytag="userrec::invites"></a><p>
1146 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1149 <table cellpadding="0" cellspacing="0" border="0">
1151 <td class="md" nowrap valign="top"> <a class="el" href="users_8h.html#a6">InvitedList</a> <a class="el" href="classuserrec.html#r0">userrec::invites</a><code> [private]</code>
1156 <table cellspacing=5 cellpadding=0 border=0>
1164 A list of channels the user has a pending invite to.
1168 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>.
1170 Referenced by <a class="el" href="users_8cpp-source.html#l00088">InviteTo()</a>, <a class="el" href="users_8cpp-source.html#l00074">IsInvited()</a>, <a class="el" href="users_8cpp-source.html#l00095">RemoveInvite()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1173 <a name="o17" doxytag="userrec::lines_in"></a><p>
1174 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1177 <table cellpadding="0" cellspacing="0" border="0">
1179 <td class="md" nowrap valign="top"> int <a class="el" href="classuserrec.html#o17">userrec::lines_in</a>
1184 <table cellspacing=5 cellpadding=0 border=0>
1196 Definition at line <a class="el" href="users_8h-source.html#l00204">204</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1198 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1201 <a name="o4" doxytag="userrec::modes"></a><p>
1202 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1205 <table cellpadding="0" cellspacing="0" border="0">
1207 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o4">userrec::modes</a>[MAXBUF]
1212 <table cellspacing=5 cellpadding=0 border=0>
1220 The user's mode string.
1222 This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.
1224 Definition at line <a class="el" href="users_8h-source.html#l00140">140</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1226 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1229 <a name="o0" doxytag="userrec::nick"></a><p>
1230 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1233 <table cellpadding="0" cellspacing="0" border="0">
1235 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o0">userrec::nick</a>[NICKMAX]
1240 <table cellspacing=5 cellpadding=0 border=0>
1250 An invalid nickname indicates an unregistered connection prior to the NICK command.
1252 Definition at line <a class="el" href="users_8h-source.html#l00121">121</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1254 Referenced by <a class="el" href="modules_8cpp-source.html#l00967">ConfigReader::DumpErrors()</a>, <a class="el" href="users_8cpp-source.html#l00061">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00068">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00700">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1257 <a name="o11" doxytag="userrec::oper"></a><p>
1258 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1261 <table cellpadding="0" cellspacing="0" border="0">
1263 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o11">userrec::oper</a>[NICKMAX]
1268 <table cellspacing=5 cellpadding=0 border=0>
1276 The oper type they logged in as, if they are an oper.
1278 This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.
1280 Definition at line <a class="el" href="users_8h-source.html#l00175">175</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1282 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1285 <a name="o14" doxytag="userrec::password"></a><p>
1286 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1289 <table cellpadding="0" cellspacing="0" border="0">
1291 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o14">userrec::password</a>[MAXBUF]
1296 <table cellspacing=5 cellpadding=0 border=0>
1304 Password specified by the user when they registered.
1306 This is stored even if the block doesnt need a password, so that modules may check it.
1308 Definition at line <a class="el" href="users_8h-source.html#l00189">189</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
1311 <a name="o13" doxytag="userrec::pingmax"></a><p>
1312 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1315 <table cellpadding="0" cellspacing="0" border="0">
1317 <td class="md" nowrap valign="top"> unsigned int <a class="el" href="classuserrec.html#o13">userrec::pingmax</a>
1322 <table cellspacing=5 cellpadding=0 border=0>
1330 Number of seconds between PINGs for this user (set from <connect:allow> tag.
1334 Definition at line <a class="el" href="users_8h-source.html#l00183">183</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td>
1337 <a name="o15" doxytag="userrec::recvq"></a><p>
1338 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1341 <table cellpadding="0" cellspacing="0" border="0">
1343 <td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o15">userrec::recvq</a>
1348 <table cellspacing=5 cellpadding=0 border=0>
1356 User's receive queue.
1358 Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy.
1360 Definition at line <a class="el" href="users_8h-source.html#l00195">195</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1362 Referenced by <a class="el" href="users_8cpp-source.html#l00169">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00195">BufferIsReady()</a>, <a class="el" href="users_8cpp-source.html#l00203">ClearBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00208">GetBuffer()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1365 <a name="o22" doxytag="userrec::recvqmax"></a><p>
1366 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1369 <table cellpadding="0" cellspacing="0" border="0">
1371 <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o22">userrec::recvqmax</a>
1376 <table cellspacing=5 cellpadding=0 border=0>
1384 Maximum size this user's recvq can become.
1388 Definition at line <a class="el" href="users_8h-source.html#l00218">218</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1390 Referenced by <a class="el" href="users_8cpp-source.html#l00169">AddBuffer()</a>. </td>
1393 <a name="o18" doxytag="userrec::reset_due"></a><p>
1394 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1397 <table cellpadding="0" cellspacing="0" border="0">
1399 <td class="md" nowrap valign="top"> time_t <a class="el" href="classuserrec.html#o18">userrec::reset_due</a>
1404 <table cellspacing=5 cellpadding=0 border=0>
1414 Definition at line <a class="el" href="users_8h-source.html#l00205">205</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1416 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1419 <a name="o8" doxytag="userrec::result"></a><p>
1420 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1423 <table cellpadding="0" cellspacing="0" border="0">
1425 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o8">userrec::result</a>[256]
1430 <table cellspacing=5 cellpadding=0 border=0>
1438 Stores the result of the last GetFullHost or GetRealHost call.
1440 You may use this to increase the speed of use of this class.
1442 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>.
1444 Referenced by <a class="el" href="users_8cpp-source.html#l00061">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00068">GetFullRealHost()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1447 <a name="o16" doxytag="userrec::sendq"></a><p>
1448 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1451 <table cellpadding="0" cellspacing="0" border="0">
1453 <td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o16">userrec::sendq</a>
1458 <table cellspacing=5 cellpadding=0 border=0>
1468 Lines waiting to be sent are stored here until their buffer is flushed.
1470 Definition at line <a class="el" href="users_8h-source.html#l00200">200</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1472 Referenced by <a class="el" href="users_8cpp-source.html#l00225">AddWriteBuf()</a>, <a class="el" href="users_8cpp-source.html#l00241">FlushWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1475 <a name="o21" doxytag="userrec::sendqmax"></a><p>
1476 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1479 <table cellpadding="0" cellspacing="0" border="0">
1481 <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o21">userrec::sendqmax</a>
1486 <table cellspacing=5 cellpadding=0 border=0>
1494 Maximum size this user's sendq can become.
1498 Definition at line <a class="el" href="users_8h-source.html#l00214">214</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1500 Referenced by <a class="el" href="users_8cpp-source.html#l00225">AddWriteBuf()</a>. </td>
1503 <a name="o6" doxytag="userrec::server"></a><p>
1504 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1507 <table cellpadding="0" cellspacing="0" border="0">
1509 <td class="md" nowrap valign="top"> char <a class="el" href="classuserrec.html#o6">userrec::server</a>[256]
1514 <table cellspacing=5 cellpadding=0 border=0>
1522 The server the user is connected to.
1526 Definition at line <a class="el" href="users_8h-source.html#l00146">146</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1528 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1531 <a name="o19" doxytag="userrec::threshold"></a><p>
1532 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1535 <table cellpadding="0" cellspacing="0" border="0">
1537 <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o19">userrec::threshold</a>
1542 <table cellspacing=5 cellpadding=0 border=0>
1552 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>. </td>
1555 <a name="o10" doxytag="userrec::timeout"></a><p>
1556 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1559 <table cellpadding="0" cellspacing="0" border="0">
1561 <td class="md" nowrap valign="top"> unsigned int <a class="el" href="classuserrec.html#o10">userrec::timeout</a>
1566 <table cellspacing=5 cellpadding=0 border=0>
1574 Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected.
1578 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>.
1580 Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td>
1583 <a name="o20" doxytag="userrec::WriteError"></a><p>
1584 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1587 <table cellpadding="0" cellspacing="0" border="0">
1589 <td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o20">userrec::WriteError</a>
1594 <table cellspacing=5 cellpadding=0 border=0>
1604 Definition at line <a class="el" href="users_8h-source.html#l00210">210</a> of file <a class="el" href="users_8h-source.html">users.h</a>.
1606 Referenced by <a class="el" href="users_8cpp-source.html#l00271">GetWriteError()</a>, and <a class="el" href="users_8cpp-source.html#l00263">SetWriteError()</a>. </td>
1609 <hr>The documentation for this class was generated from the following files:<ul>
1610 <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>
1611 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 02:00:14 2005 for InspIRCd by
1612 <a href="http://www.doxygen.org/index.html">
1613 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
1614 </a>1.3.3 </small></address>