readthrottlefilter.html

MINA+API 关于MINA的API

<a name="114" href="#114">114</a>     
<a name="115" href="#115">115</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">int</strong> maxSessionBufferSize;
<a name="116" href="#116">116</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">int</strong> maxServiceBufferSize;
<a name="117" href="#117">117</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">int</strong> maxGlobalBufferSize;
<a name="118" href="#118">118</a>     
<a name="119" href="#119">119</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> enterFilter = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">EnterFilter</a>();
<a name="120" href="#120">120</a>     
<a name="121" href="#121">121</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ScheduledExecutorService executor;
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">private</strong> ScheduledFuture&lt;?&gt; resumeOthersFuture;
<a name="123" href="#123">123</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> AtomicInteger sessionCount = <strong class="jxr_keyword">new</strong> AtomicInteger();
<a name="124" href="#124">124</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Runnable resumeOthersTask = <strong class="jxr_keyword">new</strong> Runnable() {
<a name="125" href="#125">125</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> run() {
<a name="126" href="#126">126</a>             resumeOthers();
<a name="127" href="#127">127</a>         }
<a name="128" href="#128">128</a>     };
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>     <em class="jxr_javadoccomment">/**</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * Creates a new instance with 64KB &lt;tt&gt;maxSessionBufferSize&lt;/tt&gt;,</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     * 128MB &lt;tt&gt;maxGlobalBufferSize&lt;/tt&gt; and a new {@link DefaultMessageSizeEstimator}.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     */</em>
<a name="134" href="#134">134</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">ReadThrottleFilter</a>(ScheduledExecutorService executor) {
<a name="135" href="#135">135</a>         <strong class="jxr_keyword">this</strong>(executor, ReadThrottlePolicy.LOG);
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a>     
<a name="138" href="#138">138</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">ReadThrottleFilter</a>(
<a name="139" href="#139">139</a>             ScheduledExecutorService executor, <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html">ReadThrottlePolicy</a> policy) {
<a name="140" href="#140">140</a>         <strong class="jxr_keyword">this</strong>(executor, policy, <strong class="jxr_keyword">null</strong>);
<a name="141" href="#141">141</a>     }
<a name="142" href="#142">142</a>     
<a name="143" href="#143">143</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">ReadThrottleFilter</a>(
<a name="144" href="#144">144</a>             ScheduledExecutorService executor,
<a name="145" href="#145">145</a>             <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html">ReadThrottlePolicy</a> policy, <a href="../../../../../org/apache/mina/filter/traffic/MessageSizeEstimator.html">MessageSizeEstimator</a> messageSizeEstimator) {
<a name="146" href="#146">146</a>         <em class="jxr_comment">// 64KB, 64MB, 128MB.</em>
<a name="147" href="#147">147</a>         <strong class="jxr_keyword">this</strong>(executor, policy, messageSizeEstimator, 65536, 1048576 * 64, 1048576 * 128);
<a name="148" href="#148">148</a>     }
<a name="149" href="#149">149</a>     
<a name="150" href="#150">150</a>     <em class="jxr_javadoccomment">/**</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * Creates a new instance with the specified &lt;tt&gt;maxSessionBufferSize&lt;/tt&gt;,</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * &lt;tt&gt;maxGlobalBufferSize&lt;/tt&gt; and a new {@link DefaultMessageSizeEstimator}.</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     */</em>
<a name="154" href="#154">154</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">ReadThrottleFilter</a>(
<a name="155" href="#155">155</a>             ScheduledExecutorService executor,
<a name="156" href="#156">156</a>             <strong class="jxr_keyword">int</strong> maxSessionBufferSize, <strong class="jxr_keyword">int</strong> maxServiceBufferSize, <strong class="jxr_keyword">int</strong> maxGlobalBufferSize) {
<a name="157" href="#157">157</a>         <strong class="jxr_keyword">this</strong>(executor, ReadThrottlePolicy.LOG, maxSessionBufferSize, maxServiceBufferSize, maxGlobalBufferSize);
<a name="158" href="#158">158</a>     }
<a name="159" href="#159">159</a> 
<a name="160" href="#160">160</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">ReadThrottleFilter</a>(
<a name="161" href="#161">161</a>             ScheduledExecutorService executor, <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html">ReadThrottlePolicy</a> policy,
<a name="162" href="#162">162</a>             <strong class="jxr_keyword">int</strong> maxSessionBufferSize, <strong class="jxr_keyword">int</strong> maxServiceBufferSize, <strong class="jxr_keyword">int</strong> maxGlobalBufferSize) {
<a name="163" href="#163">163</a>         <strong class="jxr_keyword">this</strong>(executor, policy, <strong class="jxr_keyword">null</strong>, maxSessionBufferSize, maxServiceBufferSize, maxGlobalBufferSize);
<a name="164" href="#164">164</a>     }
<a name="165" href="#165">165</a> 
<a name="166" href="#166">166</a>     <em class="jxr_javadoccomment">/**</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * Creates a new instance with the specified &lt;tt&gt;maxSessionBufferSize&lt;/tt&gt;,</em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * &lt;tt&gt;maxGlobalBufferSize&lt;/tt&gt; and {@link MessageSizeEstimator}.</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * </em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * @param maxSessionBufferSize the maximum amount of data in the buffer of</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     *                           the {@link ExecutorFilter} per {@link IoSession}.</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     *                           Specify {@code 0} or a smaller value to disable.</em>
<a name="173" href="#173">173</a> <em class="jxr_javadoccomment">     * @param maxGlobalBufferSize the maximum amount of data in the buffer of</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     *                            the {@link ExecutorFilter} for all {@link IoSession}</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     *                            whose {@link IoFilterChain} has been configured by</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     *                            this builder.</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     *                            Specify {@code 0} or a smaller value to disable.</em>
<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * @param messageSizeEstimator the message size estimator. If {@code null},</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     *                             a new {@link DefaultMessageSizeEstimator} is created.</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     */</em>
<a name="181" href="#181">181</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html">ReadThrottleFilter</a>(
<a name="182" href="#182">182</a>             ScheduledExecutorService executor, 
<a name="183" href="#183">183</a>             <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html">ReadThrottlePolicy</a> policy, <a href="../../../../../org/apache/mina/filter/traffic/MessageSizeEstimator.html">MessageSizeEstimator</a> messageSizeEstimator,
<a name="184" href="#184">184</a>             <strong class="jxr_keyword">int</strong> maxSessionBufferSize, <strong class="jxr_keyword">int</strong> maxServiceBufferSize, <strong class="jxr_keyword">int</strong> maxGlobalBufferSize) {
<a name="185" href="#185">185</a>         <strong class="jxr_keyword">if</strong> (messageSizeEstimator == <strong class="jxr_keyword">null</strong>) {
<a name="186" href="#186">186</a>             messageSizeEstimator = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/traffic/DefaultMessageSizeEstimator.html">DefaultMessageSizeEstimator</a>();
<a name="187" href="#187">187</a>         }
<a name="188" href="#188">188</a>         <strong class="jxr_keyword">this</strong>.executor = executor;
<a name="189" href="#189">189</a>         <strong class="jxr_keyword">this</strong>.messageSizeEstimator = messageSizeEstimator;
<a name="190" href="#190">190</a>         setPolicy(policy);
<a name="191" href="#191">191</a>         setMaxSessionBufferSize(maxSessionBufferSize);
<a name="192" href="#192">192</a>         setMaxServiceBufferSize(maxServiceBufferSize);
<a name="193" href="#193">193</a>         setMaxGlobalBufferSize(maxGlobalBufferSize);
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html">ReadThrottlePolicy</a> getPolicy() {
<a name="197" href="#197">197</a>         <strong class="jxr_keyword">return</strong> policy;
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPolicy(<a href="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html">ReadThrottlePolicy</a> policy) {
<a name="201" href="#201">201</a>         <strong class="jxr_keyword">if</strong> (policy == <strong class="jxr_keyword">null</strong>) {
<a name="202" href="#202">202</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"policy"</span>);
<a name="203" href="#203">203</a>         }
<a name="204" href="#204">204</a>         
<a name="205" href="#205">205</a>         <strong class="jxr_keyword">this</strong>.policy = policy;
<a name="206" href="#206">206</a>     }
<a name="207" href="#207">207</a> 
<a name="208" href="#208">208</a>     <em class="jxr_javadoccomment">/**</em>
<a name="209" href="#209">209</a> <em class="jxr_javadoccomment">     * Returns the maximum amount of data in the buffer of the {@link ExecutorFilter}</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     * per {@link IoSession}.  {@code 0} means 'disabled'.</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     */</em>
<a name="212" href="#212">212</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxSessionBufferSize() {
<a name="213" href="#213">213</a>         <strong class="jxr_keyword">return</strong> maxSessionBufferSize;
<a name="214" href="#214">214</a>     }
<a name="215" href="#215">215</a>     
<a name="216" href="#216">216</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxServiceBufferSize() {
<a name="217" href="#217">217</a>         <strong class="jxr_keyword">return</strong> maxServiceBufferSize;
<a name="218" href="#218">218</a>     }
<a name="219" href="#219">219</a>     
<a name="220" href="#220">220</a>     <em class="jxr_javadoccomment">/**</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment">     * Returns the maximum amount of data in the buffer of the {@link ExecutorFilter}</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * for all {@link IoSession} whose {@link IoFilterChain} has been configured by</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * this builder. {@code 0} means 'disabled'.</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     */</em>
<a name="225" href="#225">225</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getMaxGlobalBufferSize() {
<a name="226" href="#226">226</a>         <strong class="jxr_keyword">return</strong> maxGlobalBufferSize;
<a name="227" href="#227">227</a>     }
<a name="228" href="#228">228</a>     
<a name="229" href="#229">229</a>     <em class="jxr_javadoccomment">/**</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     * Sets the maximum amount of data in the buffer of the {@link ExecutorFilter}</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * per {@link IoSession}.  Specify {@code 0} or a smaller value to disable.</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     */</em>
<a name="233" href="#233">233</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMaxSessionBufferSize(<strong class="jxr_keyword">int</strong> maxSessionBufferSize) {
<a name="234" href="#234">234</a>         <strong class="jxr_keyword">if</strong> (maxSessionBufferSize &lt; 0) {
<a name="235" href="#235">235</a>             maxSessionBufferSize = 0;
<a name="236" href="#236">236</a>         }