Documented new recvq and sendq stuff

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1367 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 108 insertions, 84 deletions

diff --git a/docs/module-doc/users_8h-source.html b/docs/module-doc/users_8h-source.html
index 1ebbec1e5..8a6aee69e 100644
--- a/docs/module-doc/users_8h-source.html
+++ b/docs/module-doc/users_8h-source.html
@@ -56,96 +56,120 @@
 <a name="l00065"></a><a class="code" href="classConnectClass.html#o5">00065</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#o5">pass</a>[MAXBUF];
 00066 
 <a name="l00069"></a><a class="code" href="classConnectClass.html#o6">00069</a>         <span class="keywordtype">long</span> <a class="code" href="classConnectClass.html#o6">threshold</a>;
-00070         
-<a name="l00071"></a><a class="code" href="classConnectClass.html#a0">00071</a>         <a class="code" href="classConnectClass.html#a0">ConnectClass</a>()
-00072         {
-00073                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
-00074                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
-00075                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
-00076                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
-00077                 strlcpy(<a class="code" href="classConnectClass.html#o3">host</a>,<span class="stringliteral">""</span>,MAXBUF);
-00078                 strlcpy(<a class="code" href="classConnectClass.html#o5">pass</a>,<span class="stringliteral">""</span>,MAXBUF);
-00079         }
-00080 };
-00081 
-<a name="l00084"></a><a class="code" href="users_8h.html#a6">00084</a> <span class="keyword">typedef</span> std::vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
-00085 
-00086 
-00087 
-<a name="l00090"></a><a class="code" href="users_8h.html#a7">00090</a> <span class="keyword">typedef</span> std::vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
+00070 
+<a name="l00073"></a><a class="code" href="classConnectClass.html#o7">00073</a>         <span class="keywordtype">long</span> <a class="code" href="classConnectClass.html#o7">sendqmax</a>;
+00074 
+<a name="l00077"></a><a class="code" href="classConnectClass.html#o8">00077</a>         <span class="keywordtype">long</span> <a class="code" href="classConnectClass.html#o8">recvqmax</a>;
+00078         
+<a name="l00079"></a><a class="code" href="classConnectClass.html#a0">00079</a>         <a class="code" href="classConnectClass.html#a0">ConnectClass</a>()
+00080         {
+00081                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
+00082                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
+00083                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
+00084                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
+00085                 <a class="code" href="classConnectClass.html#o7">sendqmax</a> = 0;
+00086                 <a class="code" href="classConnectClass.html#o8">recvqmax</a> = 0;
+00087                 strlcpy(<a class="code" href="classConnectClass.html#o3">host</a>,<span class="stringliteral">""</span>,MAXBUF);
+00088                 strlcpy(<a class="code" href="classConnectClass.html#o5">pass</a>,<span class="stringliteral">""</span>,MAXBUF);
+00089         }
+00090 };
 00091 
-<a name="l00098"></a><a class="code" href="classuserrec.html">00098</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
-00099 {
-00100  <span class="keyword">private</span>:
+<a name="l00094"></a><a class="code" href="users_8h.html#a6">00094</a> <span class="keyword">typedef</span> std::vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
+00095 
+00096 
+00097 
+<a name="l00100"></a><a class="code" href="users_8h.html#a7">00100</a> <span class="keyword">typedef</span> std::vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
 00101 
-<a name="l00104"></a><a class="code" href="classuserrec.html#r0">00104</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#r0">invites</a>;
-00105  <span class="keyword">public</span>:
-00106         
-<a name="l00111"></a><a class="code" href="classuserrec.html#o0">00111</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o0">nick</a>[NICKMAX];
-00112         
-<a name="l00115"></a><a class="code" href="classuserrec.html#o1">00115</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o1">ident</a>[64];
-00116 
-<a name="l00120"></a><a class="code" href="classuserrec.html#o2">00120</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o2">dhost</a>[256];
-00121         
-<a name="l00124"></a><a class="code" href="classuserrec.html#o3">00124</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o3">fullname</a>[128];
-00125         
-<a name="l00130"></a><a class="code" href="classuserrec.html#o4">00130</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o4">modes</a>[MAXBUF];
+<a name="l00108"></a><a class="code" href="classuserrec.html">00108</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
+00109 {
+00110  <span class="keyword">private</span>:
+00111 
+<a name="l00114"></a><a class="code" href="classuserrec.html#r0">00114</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#r0">invites</a>;
+00115  <span class="keyword">public</span>:
+00116         
+<a name="l00121"></a><a class="code" href="classuserrec.html#o0">00121</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o0">nick</a>[NICKMAX];
+00122         
+<a name="l00125"></a><a class="code" href="classuserrec.html#o1">00125</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o1">ident</a>[64];
+00126 
+<a name="l00130"></a><a class="code" href="classuserrec.html#o2">00130</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o2">dhost</a>[256];
 00131         
-<a name="l00132"></a><a class="code" href="classuserrec.html#o5">00132</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#o5">chans</a>[MAXCHANS];
-00133         
-<a name="l00136"></a><a class="code" href="classuserrec.html#o6">00136</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o6">server</a>[256];
-00137         
-<a name="l00141"></a><a class="code" href="classuserrec.html#o7">00141</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o7">awaymsg</a>[512];
-00142         
-<a name="l00146"></a><a class="code" href="classuserrec.html#o8">00146</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o8">result</a>[256];
+<a name="l00134"></a><a class="code" href="classuserrec.html#o3">00134</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o3">fullname</a>[128];
+00135         
+<a name="l00140"></a><a class="code" href="classuserrec.html#o4">00140</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o4">modes</a>[MAXBUF];
+00141         
+<a name="l00142"></a><a class="code" href="classuserrec.html#o5">00142</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#o5">chans</a>[MAXCHANS];
+00143         
+<a name="l00146"></a><a class="code" href="classuserrec.html#o6">00146</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o6">server</a>[256];
 00147         
-<a name="l00152"></a><a class="code" href="classuserrec.html#o9">00152</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#o9">flood</a>;
-00153         
-<a name="l00158"></a><a class="code" href="classuserrec.html#o10">00158</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o10">timeout</a>;
-00159         
-<a name="l00165"></a><a class="code" href="classuserrec.html#o11">00165</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o11">oper</a>[NICKMAX];
-00166 
-<a name="l00169"></a><a class="code" href="classuserrec.html#o12">00169</a>         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#o12">dns_done</a>;
-00170 
-<a name="l00173"></a><a class="code" href="classuserrec.html#o13">00173</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o13">pingmax</a>;
-00174 
-<a name="l00179"></a><a class="code" href="classuserrec.html#o14">00179</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o14">password</a>[MAXBUF];
+<a name="l00151"></a><a class="code" href="classuserrec.html#o7">00151</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o7">awaymsg</a>[512];
+00152         
+<a name="l00156"></a><a class="code" href="classuserrec.html#o8">00156</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o8">result</a>[256];
+00157         
+<a name="l00162"></a><a class="code" href="classuserrec.html#o9">00162</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#o9">flood</a>;
+00163         
+<a name="l00168"></a><a class="code" href="classuserrec.html#o10">00168</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o10">timeout</a>;
+00169         
+<a name="l00175"></a><a class="code" href="classuserrec.html#o11">00175</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o11">oper</a>[NICKMAX];
+00176 
+<a name="l00179"></a><a class="code" href="classuserrec.html#o12">00179</a>         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#o12">dns_done</a>;
 00180 
-<a name="l00185"></a><a class="code" href="classuserrec.html#o15">00185</a>         std::string <a class="code" href="classuserrec.html#o15">recvq</a>;
-00186 
-<a name="l00189"></a><a class="code" href="classuserrec.html#o16">00189</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o16">lines_in</a>;
-<a name="l00190"></a><a class="code" href="classuserrec.html#o17">00190</a>         time_t <a class="code" href="classuserrec.html#o17">reset_due</a>;
-<a name="l00191"></a><a class="code" href="classuserrec.html#o18">00191</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o18">threshold</a>;
-00192 
-00193         <a class="code" href="classuserrec.html#a0">userrec</a>();
-00194         
-<a name="l00195"></a><a class="code" href="classuserrec.html#a1">00195</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
-00196         
-00201         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
-00202         
-00208         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
-00209         
-00212         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">IsInvited</a>(<span class="keywordtype">char</span>* channel);
-00213         
-00216         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">InviteTo</a>(<span class="keywordtype">char</span>* channel);
-00217         
-00222         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">RemoveInvite</a>(<span class="keywordtype">char</span>* channel);
+<a name="l00183"></a><a class="code" href="classuserrec.html#o13">00183</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o13">pingmax</a>;
+00184 
+<a name="l00189"></a><a class="code" href="classuserrec.html#o14">00189</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o14">password</a>[MAXBUF];
+00190 
+<a name="l00195"></a><a class="code" href="classuserrec.html#o15">00195</a>         std::string <a class="code" href="classuserrec.html#o15">recvq</a>;
+00196 
+<a name="l00200"></a><a class="code" href="classuserrec.html#o16">00200</a>         std::string <a class="code" href="classuserrec.html#o16">sendq</a>;
+00201 
+<a name="l00204"></a><a class="code" href="classuserrec.html#o17">00204</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o17">lines_in</a>;
+<a name="l00205"></a><a class="code" href="classuserrec.html#o18">00205</a>         time_t <a class="code" href="classuserrec.html#o18">reset_due</a>;
+<a name="l00206"></a><a class="code" href="classuserrec.html#o19">00206</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o19">threshold</a>;
+00207 
+00208         <span class="comment">/* Write error string</span>
+00209 <span class="comment">         */</span>
+<a name="l00210"></a><a class="code" href="classuserrec.html#o20">00210</a>         std::string <a class="code" href="classuserrec.html#o20">WriteError</a>;
+00211 
+<a name="l00214"></a><a class="code" href="classuserrec.html#o21">00214</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o21">sendqmax</a>;
+00215 
+<a name="l00218"></a><a class="code" href="classuserrec.html#o22">00218</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o22">recvqmax</a>;
+00219 
+00220         <a class="code" href="classuserrec.html#a0">userrec</a>();
+00221         
+<a name="l00222"></a><a class="code" href="classuserrec.html#a1">00222</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
 00223         
-00228         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a7">HasPermission</a>(<span class="keywordtype">char</span>* command);
-00229 
-00237         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a8">AddBuffer</a>(std::string a);
-00238 
-00242         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a9">BufferIsReady</a>();
-00243 
-00246         <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a10">ClearBuffer</a>();
-00247 
-00255         std::string <a class="code" href="classuserrec.html#a11">GetBuffer</a>();
-00256         
-00257 };
-00258 
-00259 
-00260 <span class="preprocessor">#endif</span>
-</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:21 2005 for InspIRCd by
+00228         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
+00229         
+00235         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
+00236         
+00239         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">IsInvited</a>(<span class="keywordtype">char</span>* channel);
+00240         
+00243         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">InviteTo</a>(<span class="keywordtype">char</span>* channel);
+00244         
+00249         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">RemoveInvite</a>(<span class="keywordtype">char</span>* channel);
+00250         
+00255         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a7">HasPermission</a>(<span class="keywordtype">char</span>* command);
+00256 
+00264         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a8">AddBuffer</a>(std::string a);
+00265 
+00269         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a9">BufferIsReady</a>();
+00270 
+00273         <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a10">ClearBuffer</a>();
+00274 
+00282         std::string <a class="code" href="classuserrec.html#a11">GetBuffer</a>();
+00283 
+00289         <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a12">SetWriteError</a>(std::string error);
+00290 
+00294         std::string <a class="code" href="classuserrec.html#a13">GetWriteError</a>();
+00295 
+00301         <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a14">AddWriteBuf</a>(std::string data);
+00302 
+00309         <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a15">FlushWriteBuf</a>();
+00310 
+00311 };
+00312 
+00313 
+00314 <span class="preprocessor">#endif</span>
+</pre></div><hr size="1"><address style="align: right;"><small>Generated on Thu May 12 02:25:14 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>