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

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

View File

@ -62,14 +62,14 @@ 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);
@ -78,7 +78,7 @@ public interface NioSocketChannelConfig extends SocketChannelConfig {
* 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();
@ -87,7 +87,7 @@ public interface NioSocketChannelConfig extends SocketChannelConfig {
* 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);