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

Clarify deprecation docs a bit. (#8226)

Browse Source 
Motivation:

It seems to sometimes confuse people what to do to replace setMaxMessagePerRead(...).

Modifications:

Add some more details to the javadocs about the correct replacement.

Result:

Related to https://github.com/netty/netty/issues/8214.
This commit is contained in:
Norman Maurer 2018-08-25 08:14:38 +02:00 committed by GitHub
parent 37a4f99f25
commit 1bd9e662dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
transport/src/main/java/io/netty/channel/ChannelConfig.java
View File

@ -121,7 +121,8 @@ public interface ChannelConfig {
ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis); ChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis);
/** /**
* @deprecated Use {@link MaxMessagesRecvByteBufAllocator} * @deprecated Use {@link MaxMessagesRecvByteBufAllocator} and
* {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead()}.
* <p> * <p>
* Returns the maximum number of messages to read per read loop. * Returns the maximum number of messages to read per read loop.
* a {@link ChannelInboundHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event. * a {@link ChannelInboundHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event.
@ -131,7 +132,8 @@ public interface ChannelConfig {
int getMaxMessagesPerRead(); int getMaxMessagesPerRead();
/** /**
* @deprecated Use {@link MaxMessagesRecvByteBufAllocator} * @deprecated Use {@link MaxMessagesRecvByteBufAllocator} and
* {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead(int)}.
* <p> * <p>
* Sets the maximum number of messages to read per read loop. * Sets the maximum number of messages to read per read loop.
* If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages. * If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.

1
transport/src/main/java/io/netty/channel/ChannelOption.java
View File

@ -78,6 +78,7 @@ public class ChannelOption<T> extends AbstractConstant<ChannelOption<T>> {
public static final ChannelOption<Integer> CONNECT_TIMEOUT_MILLIS = valueOf("CONNECT_TIMEOUT_MILLIS"); public static final ChannelOption<Integer> CONNECT_TIMEOUT_MILLIS = valueOf("CONNECT_TIMEOUT_MILLIS");
/** /**
* @deprecated Use {@link MaxMessagesRecvByteBufAllocator} * @deprecated Use {@link MaxMessagesRecvByteBufAllocator}
* and {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead(int)}.
*/ */
@Deprecated @Deprecated
public static final ChannelOption<Integer> MAX_MESSAGES_PER_READ = valueOf("MAX_MESSAGES_PER_READ"); public static final ChannelOption<Integer> MAX_MESSAGES_PER_READ = valueOf("MAX_MESSAGES_PER_READ");