andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix for NETTY-370 - documentation updated to reflect the correct behaviour of

Browse Source 
high / low water marks on the interest ops of nio channels.
This commit is contained in:
iainmcgin 2010-12-10 11:23:40 +00:00 committed by Trustin Lee
parent 1f1b8d8325
commit 4f9e6dcb13
1 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
src/main/java/org/jboss/netty/channel/socket/nio/NioSocketChannelConfig.java
View File

@ -59,36 +59,36 @@ import org.jboss.netty.channel.socket.SocketChannelConfig;
*/ */
public interface NioSocketChannelConfig extends SocketChannelConfig { public interface NioSocketChannelConfig extends SocketChannelConfig {
/** /**
* Returns the high water mark of the write buffer. If the number of bytes * Returns the high water mark of the write buffer. If the number of bytes
* queued in the write buffer exceeds this value, {@link Channel#isWritable()} * queued in the write buffer exceeds this value, {@link Channel#isWritable()}
* will start to return {@code true}. * will start to return {@code false}.
*/ */
int getWriteBufferHighWaterMark(); int getWriteBufferHighWaterMark();
/** /**
* Sets the high water mark of the write buffer. If the number of bytes * Sets the high water mark of the write buffer. If the number of bytes
* queued in the write buffer exceeds this value, {@link Channel#isWritable()} * queued in the write buffer exceeds this value, {@link Channel#isWritable()}
* will start to return {@code true}. * will start to return {@code false}.
*/ */
void setWriteBufferHighWaterMark(int writeBufferHighWaterMark); void setWriteBufferHighWaterMark(int writeBufferHighWaterMark);
/** /**
* Returns the low water mark of the write buffer. Once the number of bytes * Returns the low water mark of the write buffer. Once the number of bytes
* queued in the write buffer exceeded the * queued in the write buffer exceeded the
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then * {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
* dropped down below this value, {@link Channel#isWritable()} will return * dropped down below this value, {@link Channel#isWritable()} will return
* {@code false} again. * {@code true} again.
*/ */
int getWriteBufferLowWaterMark(); int getWriteBufferLowWaterMark();
/** /**
* Sets the low water mark of the write buffer. Once the number of bytes * Sets the low water mark of the write buffer. Once the number of bytes
* queued in the write buffer exceeded the * queued in the write buffer exceeded the
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then * {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
* dropped down below this value, {@link Channel#isWritable()} will return * dropped down below this value, {@link Channel#isWritable()} will return
* {@code false} again. * {@code true} again.
*/ */
void setWriteBufferLowWaterMark(int writeBufferLowWaterMark); void setWriteBufferLowWaterMark(int writeBufferLowWaterMark);
/** /**