readthrottlefilter.html

MINA+API 关于MINA的API

</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html#setMaxGlobalBufferSize(int)">setMaxGlobalBufferSize</A></B>(int&nbsp;maxGlobalBufferSize)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the maximum amount of data in the buffer of the <A HREF="../../../../../org/apache/mina/filter/executor/ExecutorFilter.html" title="class in org.apache.mina.filter.executor"><CODE>ExecutorFilter</CODE></A>
 for all <A HREF="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A> whose <A HREF="../../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><CODE>IoFilterChain</CODE></A> has been configured by
 this builder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html#setMaxServiceBufferSize(int)">setMaxServiceBufferSize</A></B>(int&nbsp;maxServiceBufferSize)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html#setMaxSessionBufferSize(int)">setMaxSessionBufferSize</A></B>(int&nbsp;maxSessionBufferSize)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the maximum amount of data in the buffer of the <A HREF="../../../../../org/apache/mina/filter/executor/ExecutorFilter.html" title="class in org.apache.mina.filter.executor"><CODE>ExecutorFilter</CODE></A>
 per <A HREF="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html#setPolicy(org.apache.mina.filter.traffic.ReadThrottlePolicy)">setPolicy</A></B>(<A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html" title="enum in org.apache.mina.filter.traffic">ReadThrottlePolicy</A>&nbsp;policy)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottleFilter.html#toString()">toString</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.mina.common.IoFilterAdapter"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.mina.common.<A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#destroy()">destroy</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#exceptionCaught(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession, java.lang.Throwable)">exceptionCaught</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#filterClose(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession)">filterClose</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#filterWrite(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession, org.apache.mina.common.WriteRequest)">filterWrite</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#init()">init</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#messageSent(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession, org.apache.mina.common.WriteRequest)">messageSent</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#onPreRemove(org.apache.mina.common.IoFilterChain, java.lang.String, org.apache.mina.common.IoFilter.NextFilter)">onPreRemove</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#sessionClosed(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession)">sessionClosed</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#sessionCreated(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession)">sessionCreated</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#sessionIdle(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession, org.apache.mina.common.IdleStatus)">sessionIdle</A>, <A HREF="../../../../../org/apache/mina/common/IoFilterAdapter.html#sessionOpened(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession)">sessionOpened</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ReadThrottleFilter(java.util.concurrent.ScheduledExecutorService)"><!-- --></A><H3>
ReadThrottleFilter</H3>
<PRE>
public <B>ReadThrottleFilter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</A>&nbsp;executor)</PRE>
<DL>
<DD>Creates a new instance with 64KB <tt>maxSessionBufferSize</tt>,
 128MB <tt>maxGlobalBufferSize</tt> and a new <A HREF="../../../../../org/apache/mina/filter/traffic/DefaultMessageSizeEstimator.html" title="class in org.apache.mina.filter.traffic"><CODE>DefaultMessageSizeEstimator</CODE></A>.
<P>
</DL>
<HR>

<A NAME="ReadThrottleFilter(java.util.concurrent.ScheduledExecutorService, org.apache.mina.filter.traffic.ReadThrottlePolicy)"><!-- --></A><H3>
ReadThrottleFilter</H3>
<PRE>
public <B>ReadThrottleFilter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</A>&nbsp;executor,
                          <A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html" title="enum in org.apache.mina.filter.traffic">ReadThrottlePolicy</A>&nbsp;policy)</PRE>
<DL>
</DL>
<HR>

<A NAME="ReadThrottleFilter(java.util.concurrent.ScheduledExecutorService, org.apache.mina.filter.traffic.ReadThrottlePolicy, org.apache.mina.filter.traffic.MessageSizeEstimator)"><!-- --></A><H3>
ReadThrottleFilter</H3>
<PRE>
public <B>ReadThrottleFilter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</A>&nbsp;executor,
                          <A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html" title="enum in org.apache.mina.filter.traffic">ReadThrottlePolicy</A>&nbsp;policy,
                          <A HREF="../../../../../org/apache/mina/filter/traffic/MessageSizeEstimator.html" title="interface in org.apache.mina.filter.traffic">MessageSizeEstimator</A>&nbsp;messageSizeEstimator)</PRE>
<DL>
</DL>
<HR>

<A NAME="ReadThrottleFilter(java.util.concurrent.ScheduledExecutorService, int, int, int)"><!-- --></A><H3>
ReadThrottleFilter</H3>
<PRE>
public <B>ReadThrottleFilter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</A>&nbsp;executor,
                          int&nbsp;maxSessionBufferSize,
                          int&nbsp;maxServiceBufferSize,
                          int&nbsp;maxGlobalBufferSize)</PRE>
<DL>
<DD>Creates a new instance with the specified <tt>maxSessionBufferSize</tt>,
 <tt>maxGlobalBufferSize</tt> and a new <A HREF="../../../../../org/apache/mina/filter/traffic/DefaultMessageSizeEstimator.html" title="class in org.apache.mina.filter.traffic"><CODE>DefaultMessageSizeEstimator</CODE></A>.
<P>
</DL>
<HR>

<A NAME="ReadThrottleFilter(java.util.concurrent.ScheduledExecutorService, org.apache.mina.filter.traffic.ReadThrottlePolicy, int, int, int)"><!-- --></A><H3>
ReadThrottleFilter</H3>
<PRE>
public <B>ReadThrottleFilter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</A>&nbsp;executor,
                          <A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html" title="enum in org.apache.mina.filter.traffic">ReadThrottlePolicy</A>&nbsp;policy,
                          int&nbsp;maxSessionBufferSize,
                          int&nbsp;maxServiceBufferSize,
                          int&nbsp;maxGlobalBufferSize)</PRE>
<DL>
</DL>
<HR>

<A NAME="ReadThrottleFilter(java.util.concurrent.ScheduledExecutorService, org.apache.mina.filter.traffic.ReadThrottlePolicy, org.apache.mina.filter.traffic.MessageSizeEstimator, int, int, int)"><!-- --></A><H3>
ReadThrottleFilter</H3>
<PRE>
public <B>ReadThrottleFilter</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</A>&nbsp;executor,
                          <A HREF="../../../../../org/apache/mina/filter/traffic/ReadThrottlePolicy.html" title="enum in org.apache.mina.filter.traffic">ReadThrottlePolicy</A>&nbsp;policy,
                          <A HREF="../../../../../org/apache/mina/filter/traffic/MessageSizeEstimator.html" title="interface in org.apache.mina.filter.traffic">MessageSizeEstimator</A>&nbsp;messageSizeEstimator,
                          int&nbsp;maxSessionBufferSize,
                          int&nbsp;maxServiceBufferSize,
                          int&nbsp;maxGlobalBufferSize)</PRE>
<DL>
<DD>Creates a new instance with the specified <tt>maxSessionBufferSize</tt>,
 <tt>maxGlobalBufferSize</tt> and <A HREF="../../../../../org/apache/mina/filter/traffic/MessageSizeEstimator.html" title="interface in org.apache.mina.filter.traffic"><CODE>MessageSizeEstimator</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>maxSessionBufferSize</CODE> - the maximum amount of data in the buffer of
                           the <A HREF="../../../../../org/apache/mina/filter/executor/ExecutorFilter.html" title="class in org.apache.mina.filter.executor"><CODE>ExecutorFilter</CODE></A> per <A HREF="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>.
                           Specify <code>0</code> or a smaller value to disable.<DD><CODE>maxGlobalBufferSize</CODE> - the maximum amount of data in the buffer of
                            the <A HREF="../../../../../org/apache/mina/filter/executor/ExecutorFilter.html" title="class in org.apache.mina.filter.executor"><CODE>ExecutorFilter</CODE></A> for all <A HREF="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>
                            whose <A HREF="../../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><CODE>IoFilterChain</CODE></A> has been configured by
                            this builder.
                            Specify <code>0</code> or a smaller value to disable.<DD><CODE>messageSizeEstimator</CODE> - the message size estimator. If <code>null</code>,
                             a new <A HREF="../../../../../org/apache/mina/filter/traffic/DefaultMessageSizeEstimator.html" title="class in org.apache.mina.filter.traffic"><CODE>DefaultMessageSizeEstimator</CODE></A> is created.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getGlobalBufferSize()"><!-- --></A><H3>
getGlobalBufferSize</H3>
<PRE>
public static int <B>getGlobalBufferSize</B>()</PRE>
<DL>
<DD>Returns the current amount of data in the buffer of the <A HREF="../../../../../org/apache/mina/filter/executor/ExecutorFilter.html" title="class in org.apache.mina.filter.executor"><CODE>ExecutorFilter</CODE></A>
 for all <A HREF="../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A> whose <A HREF="../../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><CODE>IoFilterChain</CODE></A> has been configured by
 this builder.
<P>