Skip to content

Commit

Permalink
Remove @deprecated for primitive WriteWaterMark getters and setters
Browse files Browse the repository at this point in the history
Motivation:

For use cases that demand frequent updates of the write watermarks, an
API that requires immutable WriteWaterMark objects is not ideal, as it
implies a lot of object allocation.

For example, the HTTP/2 child channel API uses write watermarks for outbound
flow control and updates the write watermarks on every DATA frame write.

Modifications:

Remote @deprecated tag from primitive getters and setters, however the corresponding
channel options remain deprecated.

Result:

Primitive getters and setters for write watermarks are no longer marked @deprecated.
  • Loading branch information
buchgr authored and normanmaurer committed Sep 5, 2016
1 parent 3103f05 commit 4af6855
Show file tree
Hide file tree
Showing 20 changed files with 0 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -250,14 +250,12 @@ public RxtxChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,11 +294,9 @@ public static Paritybit valueOf(int value) {
RxtxChannelConfig setAutoClose(boolean autoClose);

@Override
@Deprecated
RxtxChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
RxtxChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,14 +222,12 @@ public SctpChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public SctpChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public SctpChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,14 +203,12 @@ public SctpServerChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public SctpServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
}

@Override
@Deprecated
public SctpServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,9 @@ public interface SctpChannelConfig extends ChannelConfig {
SctpChannelConfig setAutoClose(boolean autoClose);

@Override
@Deprecated
SctpChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
SctpChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,9 @@ public interface SctpServerChannelConfig extends ChannelConfig {
SctpServerChannelConfig setAutoClose(boolean autoClose);

@Override
@Deprecated
SctpServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
SctpServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,14 +285,12 @@ public UdtChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public UdtChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
}

@Override
@Deprecated
public UdtChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,14 +181,12 @@ public UdtServerChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public UdtServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
}

@Override
@Deprecated
public UdtServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,11 +136,9 @@ public interface UdtChannelConfig extends ChannelConfig {
UdtChannelConfig setAutoClose(boolean autoClose);

@Override
@Deprecated
UdtChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
UdtChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,9 @@ public interface UdtServerChannelConfig extends UdtChannelConfig {
UdtServerChannelConfig setSystemSendBufferSize(int size);

@Override
@Deprecated
UdtServerChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
UdtServerChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
4 changes: 0 additions & 4 deletions transport/src/main/java/io/netty/channel/ChannelConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -220,13 +220,11 @@ public interface ChannelConfig {
int getWriteBufferHighWaterMark();

/**
* @deprecated Use {@link #setWriteBufferWaterMark(WriteBufferWaterMark)}
* <p>
* 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()}
* will start to return {@code false}.
*/
@Deprecated
ChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

/**
Expand All @@ -239,15 +237,13 @@ public interface ChannelConfig {
int getWriteBufferLowWaterMark();

/**
* @deprecated Use {@link #setWriteBufferWaterMark(WriteBufferWaterMark)}
* <p>
* Sets the low water mark of the write buffer. Once the number of bytes
* queued in the write buffer exceeded the
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
* dropped down below this value, {@link Channel#isWritable()} will start to return
* {@code true} again.
*/
@Deprecated
ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,13 +359,11 @@ public ChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public int getWriteBufferHighWaterMark() {
return writeBufferWaterMark.high();
}

@Override
@Deprecated
public ChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
if (writeBufferHighWaterMark < 0) {
throw new IllegalArgumentException(
Expand All @@ -387,13 +385,11 @@ public ChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
}

@Override
@Deprecated
public int getWriteBufferLowWaterMark() {
return writeBufferWaterMark.low();
}

@Override
@Deprecated
public ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
if (writeBufferLowWaterMark < 0) {
throw new IllegalArgumentException(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,14 +402,12 @@ public DatagramChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public DatagramChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public DatagramChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,14 +186,12 @@ public ServerSocketChannelConfig setAutoRead(boolean autoRead) {
}

@Override
@Deprecated
public ServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public ServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -324,14 +324,12 @@ public SocketChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public SocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public SocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,18 +107,10 @@ public interface ServerSocketChannelConfig extends ChannelConfig {
@Override
ServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator);

/**
* @deprecated Use {@link #setWriteBufferWaterMark(WriteBufferWaterMark)}
*/
@Override
@Deprecated
ServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

/**
* @deprecated Use {@link #setWriteBufferWaterMark(WriteBufferWaterMark)}
*/
@Override
@Deprecated
ServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,14 +166,12 @@ public OioServerSocketChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public OioServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public OioServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,14 +194,12 @@ public OioSocketChannelConfig setAutoClose(boolean autoClose) {
}

@Override
@Deprecated
public OioSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) {
super.setWriteBufferHighWaterMark(writeBufferHighWaterMark);
return this;
}

@Override
@Deprecated
public OioSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) {
super.setWriteBufferLowWaterMark(writeBufferLowWaterMark);
return this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,9 @@ public interface OioServerSocketChannelConfig extends ServerSocketChannelConfig
OioServerSocketChannelConfig setAutoClose(boolean autoClose);

@Override
@Deprecated
OioServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
OioServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,9 @@ public interface OioSocketChannelConfig extends SocketChannelConfig {
OioSocketChannelConfig setAutoClose(boolean autoClose);

@Override
@Deprecated
OioSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

@Override
@Deprecated
OioSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

@Override
Expand Down

0 comments on commit 4af6855

Please sign in to comment.