Package io.netty.channel
Class WriteBufferWaterMark
- java.lang.Object
-
- io.netty.channel.WriteBufferWaterMark
-
public final class WriteBufferWaterMark extends java.lang.Object
WriteBufferWaterMark is used to set low water mark and high water mark for the write buffer.If the number of bytes queued in the write buffer exceeds the high water mark,
Channel.isWritable()
will start to returnfalse
.If the number of bytes queued in the write buffer exceeds the high water mark and then dropped down below the low water mark,
Channel.isWritable()
will start to returntrue
again.Note that messages needs to be handled by the
MessageSizeEstimator
used by the channel forChannel.isWritable()
to provide accurate back-pressure.
-
-
Field Summary
Fields Modifier and Type Field Description static WriteBufferWaterMark
DEFAULT
private static int
DEFAULT_HIGH_WATER_MARK
private static int
DEFAULT_LOW_WATER_MARK
private int
high
private int
low
-
Constructor Summary
Constructors Constructor Description WriteBufferWaterMark(int low, int high)
Create a new instance.WriteBufferWaterMark(int low, int high, boolean validate)
This constructor is needed to keep backward-compatibility.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
high()
Returns the high water mark for the write buffer.int
low()
Returns the low water mark for the write buffer.java.lang.String
toString()
-
-
-
Field Detail
-
DEFAULT_LOW_WATER_MARK
private static final int DEFAULT_LOW_WATER_MARK
- See Also:
- Constant Field Values
-
DEFAULT_HIGH_WATER_MARK
private static final int DEFAULT_HIGH_WATER_MARK
- See Also:
- Constant Field Values
-
DEFAULT
public static final WriteBufferWaterMark DEFAULT
-
low
private final int low
-
high
private final int high
-
-
Constructor Detail
-
WriteBufferWaterMark
public WriteBufferWaterMark(int low, int high)
Create a new instance.- Parameters:
low
- low water mark for write buffer.high
- high water mark for write buffer
-
WriteBufferWaterMark
WriteBufferWaterMark(int low, int high, boolean validate)
This constructor is needed to keep backward-compatibility.
-
-