diff options
Diffstat (limited to 'docs/module-doc/classuserrec.html')
| -rw-r--r-- | docs/module-doc/classuserrec.html | 759 |
1 files changed, 545 insertions, 214 deletions
diff --git a/docs/module-doc/classuserrec.html b/docs/module-doc/classuserrec.html index 16ad17d03..a1d605b1b 100644 --- a/docs/module-doc/classuserrec.html +++ b/docs/module-doc/classuserrec.html @@ -49,6 +49,18 @@ Inherits <a class="el" href="classconnection.html">connection</a>. <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> <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> +<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> + +<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> +<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> + +<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> +<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> + +<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> +<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> + +<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> <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> <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> @@ -97,13 +109,24 @@ Inherits <a class="el" href="classconnection.html">connection</a>. <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> <tr><td class="mdescLeft"> </td><td class="mdescRight">User's receive queue. </em> <a href="#o15"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o16">lines_in</a></td></tr> +<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> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">User's send queue. </em> <a href="#o16"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o17">lines_in</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Flood counters. </em> <a href="#o17"></a><em><br><br></td></tr> +<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> + +<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> + +<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> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Flood counters. </em> <a href="#o16"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>time_t </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o17">reset_due</a></td></tr> +<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> -<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classuserrec.html#o18">threshold</a></td></tr> +<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> +<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> +<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> <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> <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> @@ -116,7 +139,7 @@ Everything about a connection is stored here primarily, from the user's socket I <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00098">98</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +Definition at line <a class="el" href="users_8h-source.html#l00108">108</a> of file <a class="el" href="users_8h-source.html">users.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="userrec::userrec"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> @@ -146,7 +169,7 @@ Definition at line <a class="el" href="users_8h-source.html#l00098">98</a> of fi <p> 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>. <p> -References <a class="el" href="users_8h-source.html#l00141">awaymsg</a>, <a class="el" href="connection_8h-source.html#l00231">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00235">connection::bytes_out</a>, <a class="el" href="channels_8h-source.html#l00268">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00132">chans</a>, <a class="el" href="connection_8h-source.html#l00239">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00243">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00120">dhost</a>, <a class="el" href="users_8h-source.html#l00169">dns_done</a>, <a class="el" href="connection_8h-source.html#l00215">connection::fd</a>, <a class="el" href="users_8h-source.html#l00152">flood</a>, <a class="el" href="users_8h-source.html#l00124">fullname</a>, <a class="el" href="connection_8h-source.html#l00247">connection::haspassed</a>, <a class="el" href="connection_8h-source.html#l00219">connection::host</a>, <a class="el" href="users_8h-source.html#l00115">ident</a>, <a class="el" href="connection_8h-source.html#l00273">connection::idle_lastmsg</a>, <a class="el" href="connection_8h-source.html#l00227">connection::inbuf</a>, <a class="el" href="users_8h-source.html#l00104">invites</a>, <a class="el" href="connection_8h-source.html#l00223">connection::ip</a>, <a class="el" href="connection_8h-source.html#l00265">connection::lastping</a>, <a class="el" href="users_8h-source.html#l00189">lines_in</a>, <a class="el" href="users_8h-source.html#l00130">modes</a>, <a class="el" href="users_8h-source.html#l00111">nick</a>, <a class="el" href="connection_8h-source.html#l00277">connection::nping</a>, <a class="el" href="users_8h-source.html#l00165">oper</a>, <a class="el" href="connection_8h-source.html#l00253">connection::port</a>, <a class="el" href="users_8h-source.html#l00185">recvq</a>, <a class="el" href="connection_8h-source.html#l00257">connection::registered</a>, <a class="el" href="users_8h-source.html#l00190">reset_due</a>, <a class="el" href="users_8h-source.html#l00146">result</a>, <a class="el" href="users_8h-source.html#l00136">server</a>, <a class="el" href="connection_8h-source.html#l00269">connection::signon</a>, <a class="el" href="channels_8cpp-source.html#l00107">TIME</a>, <a class="el" href="users_8h-source.html#l00158">timeout</a>, and <a class="el" href="channels_8h-source.html#l00263">ucrec::uc_modes</a>. +References <a class="el" href="users_8h-source.html#l00151">awaymsg</a>, <a class="el" href="connection_8h-source.html#l00231">connection::bytes_in</a>, <a class="el" href="connection_8h-source.html#l00235">connection::bytes_out</a>, <a class="el" href="channels_8h-source.html#l00268">ucrec::channel</a>, <a class="el" href="users_8h-source.html#l00142">chans</a>, <a class="el" href="connection_8h-source.html#l00239">connection::cmds_in</a>, <a class="el" href="connection_8h-source.html#l00243">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#l00247">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#l00273">connection::idle_lastmsg</a>, <a class="el" href="connection_8h-source.html#l00227">connection::inbuf</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#l00265">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#l00277">connection::nping</a>, <a class="el" href="users_8h-source.html#l00175">oper</a>, <a class="el" href="connection_8h-source.html#l00253">connection::port</a>, <a class="el" href="users_8h-source.html#l00195">recvq</a>, <a class="el" href="connection_8h-source.html#l00257">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#l00269">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#l00263">ucrec::uc_modes</a>. <p> <div class="fragment"><pre>00029 { 00030 <span class="comment">// the PROPER way to do it, AVOID bzero at *ALL* costs</span> @@ -162,21 +185,22 @@ References <a class="el" href="users_8h-source.html#l00141">awaymsg</a>, <a clas 00040 strcpy(server,<span class="stringliteral">""</span>); 00041 strcpy(awaymsg,<span class="stringliteral">""</span>); 00042 strcpy(oper,<span class="stringliteral">""</span>); -00043 <a class="code" href="classuserrec.html#o17">reset_due</a> = <a class="code" href="channels_8cpp.html#a37">TIME</a>; -00044 <a class="code" href="classuserrec.html#o16">lines_in</a> = 0; +00043 <a class="code" href="classuserrec.html#o18">reset_due</a> = <a class="code" href="channels_8cpp.html#a37">TIME</a>; +00044 <a class="code" href="classuserrec.html#o17">lines_in</a> = 0; 00045 <a class="code" href="classconnection.html#o0">fd</a> = <a class="code" href="classconnection.html#o12">lastping</a> = <a class="code" href="classconnection.html#o13">signon</a> = <a class="code" href="classconnection.html#o14">idle_lastmsg</a> = <a class="code" href="classconnection.html#o15">nping</a> = <a class="code" href="classconnection.html#o10">registered</a> = 0; 00046 <a class="code" href="classuserrec.html#o9">flood</a> = <a class="code" href="classconnection.html#o9">port</a> = <a class="code" href="classconnection.html#o4">bytes_in</a> = <a class="code" href="classconnection.html#o5">bytes_out</a> = <a class="code" href="classconnection.html#o6">cmds_in</a> = <a class="code" href="classconnection.html#o7">cmds_out</a> = 0; 00047 <a class="code" href="classconnection.html#o8">haspassed</a> = <span class="keyword">false</span>; 00048 <a class="code" href="classuserrec.html#o12">dns_done</a> = <span class="keyword">false</span>; 00049 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>; -00050 strcpy(result,<span class="stringliteral">""</span>); -00051 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < MAXCHANS; i++) -00052 { -00053 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o1">channel</a> = NULL; -00054 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o0">uc_modes</a> = 0; -00055 } -00056 <a class="code" href="classuserrec.html#r0">invites</a>.clear(); -00057 } +00050 <a class="code" href="classuserrec.html#o16">sendq</a> = <span class="stringliteral">""</span>; +00051 strcpy(result,<span class="stringliteral">""</span>); +00052 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < MAXCHANS; i++) +00053 { +00054 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o1">channel</a> = NULL; +00055 this-><a class="code" href="classuserrec.html#o5">chans</a>[i].<a class="code" href="classucrec.html#o0">uc_modes</a> = 0; +00056 } +00057 <a class="code" href="classuserrec.html#r0">invites</a>.clear(); +00058 } </pre></div> </td> </tr> </table> @@ -207,9 +231,9 @@ References <a class="el" href="users_8h-source.html#l00141">awaymsg</a>, <a clas <p> <p> -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>. +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>. <p> -<div class="fragment"><pre>00195 { } +<div class="fragment"><pre>00222 { } </pre></div> </td> </tr> </table> @@ -244,29 +268,84 @@ This method adds data to the buffer of the user. <p> 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. <p> -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>. -<p> -References <a class="el" href="users_8h-source.html#l00185">recvq</a>. -<p> -<div class="fragment"><pre>00170 { -00171 std::string b = <span class="stringliteral">""</span>; -00172 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < a.length(); i++) -00173 <span class="keywordflow">if</span> ((a[i] != <span class="charliteral">'\r'</span>) && (a[i] != <span class="charliteral">'\0'</span>) && (a[i] != 7)) -00174 b = b + a[i]; -00175 std::stringstream stream(recvq); -00176 stream << b; -00177 <a class="code" href="classuserrec.html#o15">recvq</a> = stream.str(); -00178 <span class="keywordtype">int</span> i = 0; -00179 <span class="comment">// count the size of the first line in the buffer.</span> -00180 <span class="keywordflow">while</span> (i < <a class="code" href="classuserrec.html#o15">recvq</a>.length()) -00181 { -00182 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i++] == <span class="charliteral">'\n'</span>) -00183 <span class="keywordflow">break</span>; -00184 } -00185 <span class="comment">// return false if we've had more than 600 characters WITHOUT</span> -00186 <span class="comment">// a carriage return (this is BAD, drop the socket)</span> -00187 <span class="keywordflow">return</span> (i < 600); -00188 } +Definition at line <a class="el" href="users_8cpp-source.html#l00170">170</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +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#l00264">SetWriteError()</a>. +<p> +<div class="fragment"><pre>00171 { +00172 std::string b = <span class="stringliteral">""</span>; +00173 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < a.length(); i++) +00174 <span class="keywordflow">if</span> ((a[i] != <span class="charliteral">'\r'</span>) && (a[i] != <span class="charliteral">'\0'</span>) && (a[i] != 7)) +00175 b = b + a[i]; +00176 std::stringstream stream(recvq); +00177 stream << b; +00178 <a class="code" href="classuserrec.html#o15">recvq</a> = stream.str(); +00179 <span class="keywordtype">int</span> i = 0; +00180 <span class="comment">// count the size of the first line in the buffer.</span> +00181 <span class="keywordflow">while</span> (i < <a class="code" href="classuserrec.html#o15">recvq</a>.length()) +00182 { +00183 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i++] == <span class="charliteral">'\n'</span>) +00184 <span class="keywordflow">break</span>; +00185 } +00186 <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>) +00187 { +00188 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(<span class="stringliteral">"RecvQ exceeded"</span>); +00189 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>); +00190 } +00191 <span class="comment">// return false if we've had more than 600 characters WITHOUT</span> +00192 <span class="comment">// a carriage return (this is BAD, drop the socket)</span> +00193 <span class="keywordflow">return</span> (i < 600); +00194 } +</pre></div> </td> + </tr> +</table> +<a name="a14" doxytag="userrec::AddWriteBuf"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void userrec::AddWriteBuf </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>data</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds to the user's write buffer. +<p> +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. +<p> +Definition at line <a class="el" href="users_8cpp-source.html#l00226">226</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +References <a class="el" href="users_8cpp-source.html#l00272">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#l00264">SetWriteError()</a>. +<p> +<div class="fragment"><pre>00227 { +00228 <span class="keywordflow">if</span> (this-><a class="code" href="classuserrec.html#a13">GetWriteError</a>() != <span class="stringliteral">""</span>) +00229 <span class="keywordflow">return</span>; +00230 <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>) +00231 { +00232 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>); +00233 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(<span class="stringliteral">"SendQ exceeded"</span>); +00234 <span class="keywordflow">return</span>; +00235 } +00236 std::stringstream stream; +00237 stream << <a class="code" href="classuserrec.html#o16">sendq</a> << data; +00238 <a class="code" href="classuserrec.html#o16">sendq</a> = stream.str(); +00239 } </pre></div> </td> </tr> </table> @@ -299,16 +378,16 @@ This method returns true if the buffer contains at least one carriage return cha <p> one complete line may be read) <p> -Definition at line <a class="el" href="users_8cpp-source.html#l00190">190</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +Definition at line <a class="el" href="users_8cpp-source.html#l00196">196</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00185">recvq</a>. +References <a class="el" href="users_8h-source.html#l00195">recvq</a>. <p> -<div class="fragment"><pre>00191 { -00192 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="classuserrec.html#o15">recvq</a>.length(); i++) -00193 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i] == <span class="charliteral">'\n'</span>) -00194 <span class="keywordflow">return</span> <span class="keyword">true</span>; -00195 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00196 } +<div class="fragment"><pre>00197 { +00198 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < <a class="code" href="classuserrec.html#o15">recvq</a>.length(); i++) +00199 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a>[i] == <span class="charliteral">'\n'</span>) +00200 <span class="keywordflow">return</span> <span class="keyword">true</span>; +00201 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00202 } </pre></div> </td> </tr> </table> @@ -341,15 +420,71 @@ This function clears the entire buffer by setting it to an empty string. <p> <p> -Definition at line <a class="el" href="users_8cpp-source.html#l00198">198</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +Definition at line <a class="el" href="users_8cpp-source.html#l00204">204</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +References <a class="el" href="users_8h-source.html#l00195">recvq</a>. +<p> +Referenced by <a class="el" href="modules_8cpp-source.html#l00699">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00680">Server::UserToPseudo()</a>. +<p> +<div class="fragment"><pre>00205 { +00206 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>; +00207 } +</pre></div> </td> + </tr> +</table> +<a name="a15" doxytag="userrec::FlushWriteBuf"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void userrec::FlushWriteBuf </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Flushes as much of the user's buffer to the file descriptor as possible. +<p> +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. <p> -References <a class="el" href="users_8h-source.html#l00185">recvq</a>. +Definition at line <a class="el" href="users_8cpp-source.html#l00242">242</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00671">Server::UserToPseudo()</a>. +References <a class="el" href="connection_8h-source.html#l00235">connection::bytes_out</a>, <a class="el" href="connection_8h-source.html#l00243">connection::cmds_out</a>, <a class="el" href="users_8h-source.html#l00200">sendq</a>, and <a class="el" href="users_8cpp-source.html#l00264">SetWriteError()</a>. <p> -<div class="fragment"><pre>00199 { -00200 <a class="code" href="classuserrec.html#o15">recvq</a> = <span class="stringliteral">""</span>; -00201 } +<div class="fragment"><pre>00243 { +00244 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o16">sendq</a>.length()) +00245 { +00246 <span class="keywordtype">char</span>* tb = (<span class="keywordtype">char</span>*)this-><a class="code" href="classuserrec.html#o16">sendq</a>.c_str(); +00247 <span class="keywordtype">int</span> n_sent = write(this->fd,tb,this->sendq.length()); +00248 <span class="keywordflow">if</span> (n_sent == -1) +00249 { +00250 this-><a class="code" href="classuserrec.html#a12">SetWriteError</a>(strerror(errno)); +00251 } +00252 <span class="keywordflow">else</span> +00253 { +00254 <span class="comment">// advance the queue</span> +00255 tb += n_sent; +00256 this-><a class="code" href="classuserrec.html#o16">sendq</a> = tb; +00257 <span class="comment">// update the user's stats counters</span> +00258 this-><a class="code" href="classconnection.html#o5">bytes_out</a> += n_sent; +00259 this-><a class="code" href="classconnection.html#o7">cmds_out</a>++; +00260 } +00261 } +00262 } </pre></div> </td> </tr> </table> @@ -382,25 +517,25 @@ This method returns the first available string at the tail end of the buffer and <p> 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>. <p> -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>. -<p> -References <a class="el" href="users_8h-source.html#l00185">recvq</a>. -<p> -<div class="fragment"><pre>00204 { -00205 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a> == <span class="stringliteral">""</span>) -00206 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; -00207 <span class="keywordtype">char</span>* line = (<span class="keywordtype">char</span>*)<a class="code" href="classuserrec.html#o15">recvq</a>.c_str(); -00208 std::string ret = <span class="stringliteral">""</span>; -00209 <span class="keywordflow">while</span> ((*line != <span class="charliteral">'\n'</span>) && (strlen(line))) -00210 { -00211 ret = ret + *line; -00212 line++; -00213 } -00214 <span class="keywordflow">if</span> ((*line == <span class="charliteral">'\n'</span>) || (*line == <span class="charliteral">'\r'</span>)) -00215 line++; -00216 <a class="code" href="classuserrec.html#o15">recvq</a> = line; -00217 <span class="keywordflow">return</span> ret; -00218 } +Definition at line <a class="el" href="users_8cpp-source.html#l00209">209</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +References <a class="el" href="users_8h-source.html#l00195">recvq</a>. +<p> +<div class="fragment"><pre>00210 { +00211 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#o15">recvq</a> == <span class="stringliteral">""</span>) +00212 <span class="keywordflow">return</span> <span class="stringliteral">""</span>; +00213 <span class="keywordtype">char</span>* line = (<span class="keywordtype">char</span>*)<a class="code" href="classuserrec.html#o15">recvq</a>.c_str(); +00214 std::string ret = <span class="stringliteral">""</span>; +00215 <span class="keywordflow">while</span> ((*line != <span class="charliteral">'\n'</span>) && (strlen(line))) +00216 { +00217 ret = ret + *line; +00218 line++; +00219 } +00220 <span class="keywordflow">if</span> ((*line == <span class="charliteral">'\n'</span>) || (*line == <span class="charliteral">'\r'</span>)) +00221 line++; +00222 <a class="code" href="classuserrec.html#o15">recvq</a> = line; +00223 <span class="keywordflow">return</span> ret; +00224 } </pre></div> </td> </tr> </table> @@ -433,14 +568,14 @@ Returns the full displayed host of the user This member function returns the hos <p> <p> -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>. +Definition at line <a class="el" href="users_8cpp-source.html#l00062">62</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00120">dhost</a>, <a class="el" href="users_8h-source.html#l00115">ident</a>, <a class="el" href="users_8h-source.html#l00111">nick</a>, and <a class="el" href="users_8h-source.html#l00146">result</a>. +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>. <p> -<div class="fragment"><pre>00062 { -00063 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost); -00064 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>; -00065 } +<div class="fragment"><pre>00063 { +00064 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,dhost); +00065 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>; +00066 } </pre></div> </td> </tr> </table> @@ -473,14 +608,55 @@ Returns the full real host of the user This member function returns the hostname <p> 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. <p> -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>. +Definition at line <a class="el" href="users_8cpp-source.html#l00069">69</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="connection_8h-source.html#l00219">connection::host</a>, <a class="el" href="users_8h-source.html#l00115">ident</a>, <a class="el" href="users_8h-source.html#l00111">nick</a>, and <a class="el" href="users_8h-source.html#l00146">result</a>. +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>. <p> -<div class="fragment"><pre>00069 { -00070 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host); -00071 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>; -00072 } +<div class="fragment"><pre>00070 { +00071 snprintf(result,MAXBUF,<span class="stringliteral">"%s!%s@%s"</span>,nick,ident,host); +00072 <span class="keywordflow">return</span> <a class="code" href="classuserrec.html#o8">result</a>; +00073 } +</pre></div> </td> + </tr> +</table> +<a name="a13" doxytag="userrec::GetWriteError"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string userrec::GetWriteError </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the write error which last occured on this connection or an empty string if none occured. +<p> + +<p> +Definition at line <a class="el" href="users_8cpp-source.html#l00272">272</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +References <a class="el" href="users_8h-source.html#l00210">WriteError</a>. +<p> +Referenced by <a class="el" href="users_8cpp-source.html#l00226">AddWriteBuf()</a>. +<p> +<div class="fragment"><pre>00273 { +00274 <span class="keywordflow">return</span> this-><a class="code" href="classuserrec.html#o20">WriteError</a>; +00275 } </pre></div> </td> </tr> </table> @@ -514,59 +690,59 @@ Returns true or false for if a user can execute a privilaged oper command. <p> 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. <p> -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>. +Definition at line <a class="el" href="users_8cpp-source.html#l00118">118</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> 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>. <p> -<div class="fragment"><pre>00118 { -00119 <span class="keywordtype">char</span> TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -00120 <span class="keywordtype">char</span>* mycmd; -00121 <span class="keywordtype">char</span>* savept; -00122 <span class="keywordtype">char</span>* savept2; -00123 -00124 <span class="comment">// are they even an oper at all?</span> -00125 <span class="keywordflow">if</span> (strchr(this->modes,<span class="charliteral">'o'</span>)) -00126 { -00127 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper"</span>,this->nick); -00128 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j =0; j < ConfValueEnum(<span class="stringliteral">"type"</span>,&config_f); j++) -00129 { -00130 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"name"</span>,j,TypeName,&config_f); -00131 <span class="keywordflow">if</span> (!strcmp(TypeName,this->oper)) -00132 { -00133 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper of type '%s'"</span>,this->nick,this->oper); -00134 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"classes"</span>,j,Classes,&config_f); -00135 <span class="keywordtype">char</span>* myclass = strtok_r(Classes,<span class="stringliteral">" "</span>,&savept); -00136 <span class="keywordflow">while</span> (myclass) -00137 { -00138 log(DEBUG,<span class="stringliteral">"*** HasPermission: checking classtype '%s'"</span>,myclass); -00139 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> k =0; k < ConfValueEnum(<span class="stringliteral">"class"</span>,&config_f); k++) -00140 { -00141 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"name"</span>,k,ClassName,&config_f); -00142 <span class="keywordflow">if</span> (!strcmp(ClassName,myclass)) -00143 { -00144 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"commands"</span>,k,CommandList,&config_f); -00145 log(DEBUG,<span class="stringliteral">"*** HasPermission: found class named %s with commands: '%s'"</span>,ClassName,CommandList); -00146 +<div class="fragment"><pre>00119 { +00120 <span class="keywordtype">char</span> TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +00121 <span class="keywordtype">char</span>* mycmd; +00122 <span class="keywordtype">char</span>* savept; +00123 <span class="keywordtype">char</span>* savept2; +00124 +00125 <span class="comment">// are they even an oper at all?</span> +00126 <span class="keywordflow">if</span> (strchr(this->modes,<span class="charliteral">'o'</span>)) +00127 { +00128 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper"</span>,this->nick); +00129 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j =0; j < ConfValueEnum(<span class="stringliteral">"type"</span>,&config_f); j++) +00130 { +00131 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"name"</span>,j,TypeName,&config_f); +00132 <span class="keywordflow">if</span> (!strcmp(TypeName,this->oper)) +00133 { +00134 log(DEBUG,<span class="stringliteral">"*** HasPermission: %s is an oper of type '%s'"</span>,this->nick,this->oper); +00135 ConfValue(<span class="stringliteral">"type"</span>,<span class="stringliteral">"classes"</span>,j,Classes,&config_f); +00136 <span class="keywordtype">char</span>* myclass = strtok_r(Classes,<span class="stringliteral">" "</span>,&savept); +00137 <span class="keywordflow">while</span> (myclass) +00138 { +00139 log(DEBUG,<span class="stringliteral">"*** HasPermission: checking classtype '%s'"</span>,myclass); +00140 <span class="keywordflow">for</span> (<span class="keywordtype">int</span> k =0; k < ConfValueEnum(<span class="stringliteral">"class"</span>,&config_f); k++) +00141 { +00142 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"name"</span>,k,ClassName,&config_f); +00143 <span class="keywordflow">if</span> (!strcmp(ClassName,myclass)) +00144 { +00145 ConfValue(<span class="stringliteral">"class"</span>,<span class="stringliteral">"commands"</span>,k,CommandList,&config_f); +00146 log(DEBUG,<span class="stringliteral">"*** HasPermission: found class named %s with commands: '%s'"</span>,ClassName,CommandList); 00147 -00148 mycmd = strtok_r(CommandList,<span class="stringliteral">" "</span>,&savept2); -00149 <span class="keywordflow">while</span> (mycmd) -00150 { -00151 <span class="keywordflow">if</span> (!strcasecmp(mycmd,command)) -00152 { -00153 log(DEBUG,<span class="stringliteral">"*** Command %s found, returning true"</span>,command); -00154 <span class="keywordflow">return</span> <span class="keyword">true</span>; -00155 } -00156 mycmd = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept2); -00157 } -00158 } -00159 } -00160 myclass = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept); -00161 } -00162 } -00163 } -00164 } -00165 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00166 } +00148 +00149 mycmd = strtok_r(CommandList,<span class="stringliteral">" "</span>,&savept2); +00150 <span class="keywordflow">while</span> (mycmd) +00151 { +00152 <span class="keywordflow">if</span> (!strcasecmp(mycmd,command)) +00153 { +00154 log(DEBUG,<span class="stringliteral">"*** Command %s found, returning true"</span>,command); +00155 <span class="keywordflow">return</span> <span class="keyword">true</span>; +00156 } +00157 mycmd = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept2); +00158 } +00159 } +00160 } +00161 myclass = strtok_r(NULL,<span class="stringliteral">" "</span>,&savept); +00162 } +00163 } +00164 } +00165 } +00166 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00167 } </pre></div> </td> </tr> </table> @@ -600,15 +776,15 @@ Adds a channel to a users invite list (invites them to a channel). <p> <p> -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>. +Definition at line <a class="el" href="users_8cpp-source.html#l00089">89</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00039">Invited::channel</a>, and <a class="el" href="users_8h-source.html#l00104">invites</a>. +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>. <p> -<div class="fragment"><pre>00089 { -00090 <a class="code" href="classInvited.html">Invited</a> i; -00091 strlcpy(i.<a class="code" href="classInvited.html#o0">channel</a>,channel,CHANMAX); -00092 <a class="code" href="classuserrec.html#r0">invites</a>.push_back(i); -00093 } +<div class="fragment"><pre>00090 { +00091 <a class="code" href="classInvited.html">Invited</a> i; +00092 strlcpy(i.<a class="code" href="classInvited.html#o0">channel</a>,channel,CHANMAX); +00093 <a class="code" href="classuserrec.html#r0">invites</a>.push_back(i); +00094 } </pre></div> </td> </tr> </table> @@ -642,22 +818,22 @@ Returns true if a user is invited to a channel. <p> <p> -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>. +Definition at line <a class="el" href="users_8cpp-source.html#l00075">75</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. <p> -References <a class="el" href="users_8h-source.html#l00104">invites</a>. +References <a class="el" href="users_8h-source.html#l00114">invites</a>. <p> -<div class="fragment"><pre>00075 { -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++) -00077 { -00078 <span class="keywordflow">if</span> (i->channel) { -00079 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel)) -00080 { -00081 <span class="keywordflow">return</span> <span class="keyword">true</span>; -00082 } -00083 } -00084 } -00085 <span class="keywordflow">return</span> <span class="keyword">false</span>; -00086 } +<div class="fragment"><pre>00076 { +00077 <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++) +00078 { +00079 <span class="keywordflow">if</span> (i->channel) { +00080 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel)) +00081 { +00082 <span class="keywordflow">return</span> <span class="keyword">true</span>; +00083 } +00084 } +00085 } +00086 <span class="keywordflow">return</span> <span class="keyword">false</span>; +00087 } </pre></div> </td> </tr> </table> @@ -691,30 +867,75 @@ Removes a channel from a users invite list. <p> This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation. <p> -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>. -<p> -References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00104">invites</a>. -<p> -<div class="fragment"><pre>00096 { -00097 log(DEBUG,<span class="stringliteral">"Removing invites"</span>); -00098 <span class="keywordflow">if</span> (channel) -00099 { -00100 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#r0">invites</a>.size()) -00101 { -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++) -00103 { -00104 <span class="keywordflow">if</span> (i->channel) -00105 { -00106 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel)) -00107 { -00108 <a class="code" href="classuserrec.html#r0">invites</a>.erase(i); -00109 <span class="keywordflow">return</span>; -00110 } -00111 } -00112 } -00113 } -00114 } -00115 } +Definition at line <a class="el" href="users_8cpp-source.html#l00096">96</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00114">invites</a>. +<p> +<div class="fragment"><pre>00097 { +00098 log(DEBUG,<span class="stringliteral">"Removing invites"</span>); +00099 <span class="keywordflow">if</span> (channel) +00100 { +00101 <span class="keywordflow">if</span> (<a class="code" href="classuserrec.html#r0">invites</a>.size()) +00102 { +00103 <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++) +00104 { +00105 <span class="keywordflow">if</span> (i->channel) +00106 { +00107 <span class="keywordflow">if</span> (!strcasecmp(i->channel,channel)) +00108 { +00109 <a class="code" href="classuserrec.html#r0">invites</a>.erase(i); +00110 <span class="keywordflow">return</span>; +00111 } +00112 } +00113 } +00114 } +00115 } +00116 } +</pre></div> </td> + </tr> +</table> +<a name="a12" doxytag="userrec::SetWriteError"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void userrec::SetWriteError </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>error</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the write error for a connection. +<p> +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. +<p> +Definition at line <a class="el" href="users_8cpp-source.html#l00264">264</a> of file <a class="el" href="users_8cpp-source.html">users.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="users_8h-source.html#l00210">WriteError</a>. +<p> +Referenced by <a class="el" href="users_8cpp-source.html#l00170">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00226">AddWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00242">FlushWriteBuf()</a>. +<p> +<div class="fragment"><pre>00265 { +00266 log(DEBUG,<span class="stringliteral">"Setting error string for %s to '%s'"</span>,this->nick,error.c_str()); +00267 <span class="comment">// don't try to set the error twice, its already set take the first string.</span> +00268 <span class="keywordflow">if</span> (this-><a class="code" href="classuserrec.html#o20">WriteError</a> == <span class="stringliteral">""</span>) +00269 this-><a class="code" href="classuserrec.html#o20">WriteError</a> = error; +00270 } </pre></div> </td> </tr> </table> @@ -742,7 +963,7 @@ The user's away message. <p> If this string is empty, the user is not marked as away. <p> -Definition at line <a class="el" href="users_8h-source.html#l00141">141</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00151">151</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -768,9 +989,9 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00132">132</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +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>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00699">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> <a name="o2" doxytag="userrec::dhost"></a><p> @@ -796,9 +1017,9 @@ The host displayed to non-opers (used for cloaking etc). <p> This usually matches the value of <a class="el" href="classconnection.html#o1">userrec::host</a>. <p> -Definition at line <a class="el" href="users_8h-source.html#l00120">120</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00130">130</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> -Referenced by <a class="el" href="users_8cpp-source.html#l00061">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> +Referenced by <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> <a name="o12" doxytag="userrec::dns_done"></a><p> @@ -824,7 +1045,7 @@ True when <a class="el" href="classDNS.html">DNS</a> lookups are completed. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00169">169</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00179">179</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -852,7 +1073,7 @@ Number of lines the user can place into the buffer (up to the global NetBufferSi <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00152">152</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00162">162</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -880,7 +1101,7 @@ The users full name. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00124">124</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00134">134</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -908,9 +1129,9 @@ The users ident reply. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00115">115</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00125">125</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> -Referenced by <a class="el" href="users_8cpp-source.html#l00061">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00068">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00681">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00671">Server::UserToPseudo()</a>. </td> +Referenced by <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00069">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00699">Server::PseudoToUser()</a>, <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>, and <a class="el" href="modules_8cpp-source.html#l00680">Server::UserToPseudo()</a>. </td> </tr> </table> <a name="r0" doxytag="userrec::invites"></a><p> @@ -936,18 +1157,18 @@ A list of channels the user has a pending invite to. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00104">104</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +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>. <p> -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> +Referenced by <a class="el" href="users_8cpp-source.html#l00089">InviteTo()</a>, <a class="el" href="users_8cpp-source.html#l00075">IsInvited()</a>, <a class="el" href="users_8cpp-source.html#l00096">RemoveInvite()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> -<a name="o16" doxytag="userrec::lines_in"></a><p> +<a name="o17" doxytag="userrec::lines_in"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o16">userrec::lines_in</a> + <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o17">userrec::lines_in</a> </table> </td> </tr> @@ -964,7 +1185,7 @@ Flood counters. <p> <p> -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>. +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>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -992,7 +1213,7 @@ The user's mode string. <p> This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit. <p> -Definition at line <a class="el" href="users_8h-source.html#l00130">130</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00140">140</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -1020,9 +1241,9 @@ The users nickname. <p> An invalid nickname indicates an unregistered connection prior to the NICK command. <p> -Definition at line <a class="el" href="users_8h-source.html#l00111">111</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00121">121</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00948">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#l00681">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00966">ConfigReader::DumpErrors()</a>, <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00069">GetFullRealHost()</a>, <a class="el" href="modules_8cpp-source.html#l00699">Server::PseudoToUser()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> <a name="o11" doxytag="userrec::oper"></a><p> @@ -1048,7 +1269,7 @@ The oper type they logged in as, if they are an oper. <p> 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. <p> -Definition at line <a class="el" href="users_8h-source.html#l00165">165</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00175">175</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -1076,7 +1297,7 @@ Password specified by the user when they registered. <p> This is stored even if the block doesnt need a password, so that modules may check it. <p> -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>. </td> +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> </tr> </table> <a name="o13" doxytag="userrec::pingmax"></a><p> @@ -1102,7 +1323,7 @@ Number of seconds between PINGs for this user (set from <connect:allow> ta <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00173">173</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +Definition at line <a class="el" href="users_8h-source.html#l00183">183</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> </tr> </table> <a name="o15" doxytag="userrec::recvq"></a><p> @@ -1128,18 +1349,18 @@ User's receive queue. <p> Lines from the IRCd awaiting processing are stored here. Upgraded april 2005, old system a bit hairy. <p> -Definition at line <a class="el" href="users_8h-source.html#l00185">185</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00195">195</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> -Referenced by <a class="el" href="users_8cpp-source.html#l00169">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00190">BufferIsReady()</a>, <a class="el" href="users_8cpp-source.html#l00198">ClearBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00203">GetBuffer()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> +Referenced by <a class="el" href="users_8cpp-source.html#l00170">AddBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00196">BufferIsReady()</a>, <a class="el" href="users_8cpp-source.html#l00204">ClearBuffer()</a>, <a class="el" href="users_8cpp-source.html#l00209">GetBuffer()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> -<a name="o17" doxytag="userrec::reset_due"></a><p> +<a name="o22" doxytag="userrec::recvqmax"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> time_t <a class="el" href="classuserrec.html#o17">userrec::reset_due</a> + <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o22">userrec::recvqmax</a> </table> </td> </tr> @@ -1152,9 +1373,37 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00169">AddBuffer()</a> <td> <p> +Maximum size this user's recvq can become. +<p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00190">190</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00218">218</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +<p> +Referenced by <a class="el" href="users_8cpp-source.html#l00170">AddBuffer()</a>. </td> + </tr> +</table> +<a name="o18" doxytag="userrec::reset_due"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> time_t <a class="el" href="classuserrec.html#o18">userrec::reset_due</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +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>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> @@ -1182,9 +1431,65 @@ Stores the result of the last GetFullHost or GetRealHost call. <p> You may use this to increase the speed of use of this class. <p> -Definition at line <a class="el" href="users_8h-source.html#l00146">146</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00156">156</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> -Referenced by <a class="el" href="users_8cpp-source.html#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> +Referenced by <a class="el" href="users_8cpp-source.html#l00062">GetFullHost()</a>, <a class="el" href="users_8cpp-source.html#l00069">GetFullRealHost()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> + </tr> +</table> +<a name="o16" doxytag="userrec::sendq"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o16">userrec::sendq</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +User's send queue. +<p> +Lines waiting to be sent are stored here until their buffer is flushed. +<p> +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>. +<p> +Referenced by <a class="el" href="users_8cpp-source.html#l00226">AddWriteBuf()</a>, <a class="el" href="users_8cpp-source.html#l00242">FlushWriteBuf()</a>, and <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> + </tr> +</table> +<a name="o21" doxytag="userrec::sendqmax"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o21">userrec::sendqmax</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Maximum size this user's sendq can become. +<p> + +<p> +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>. +<p> +Referenced by <a class="el" href="users_8cpp-source.html#l00226">AddWriteBuf()</a>. </td> </tr> </table> <a name="o6" doxytag="userrec::server"></a><p> @@ -1210,18 +1515,18 @@ The server the user is connected to. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00136">136</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +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>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> -<a name="o18" doxytag="userrec::threshold"></a><p> +<a name="o19" doxytag="userrec::threshold"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o18">userrec::threshold</a> + <td class="md" nowrap valign="top"> long <a class="el" href="classuserrec.html#o19">userrec::threshold</a> </table> </td> </tr> @@ -1236,7 +1541,7 @@ Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00191">191</a> of file <a class="el" href="users_8h-source.html">users.h</a>. </td> +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> </tr> </table> <a name="o10" doxytag="userrec::timeout"></a><p> @@ -1262,14 +1567,40 @@ Number of seconds this user is given to send USER/NICK If they do not send their <p> <p> -Definition at line <a class="el" href="users_8h-source.html#l00158">158</a> of file <a class="el" href="users_8h-source.html">users.h</a>. +Definition at line <a class="el" href="users_8h-source.html#l00168">168</a> of file <a class="el" href="users_8h-source.html">users.h</a>. <p> Referenced by <a class="el" href="users_8cpp-source.html#l00028">userrec()</a>. </td> </tr> </table> +<a name="o20" doxytag="userrec::WriteError"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string <a class="el" href="classuserrec.html#o20">userrec::WriteError</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +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>. +<p> +Referenced by <a class="el" href="users_8cpp-source.html#l00272">GetWriteError()</a>, and <a class="el" href="users_8cpp-source.html#l00264">SetWriteError()</a>. </td> + </tr> +</table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="users_8h-source.html">users.h</a><li><a class="el" href="users_8cpp-source.html">users.cpp</a></ul> -<hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:29 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Thu May 12 02:25:29 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.3 </small></address> |