a68264dc02
Motivation: ChannelMetadata has a field minMaxMessagesPerRead which can be confusing. There are also some cases where static instances are used and the default value for channel type is not being applied. Modifications: - use a default value which is set unconditionally to simplify - make sure static instances of MaxMessagesRecvByteBufAllocator are not used if the intention is that the default maxMessagesPerRead should be derived from the channel type. Result: Less confusing interfaces in ChannelMetadata and ChannelConfig. Default maxMessagesPerRead is correctly applied.
74 lines
2.9 KiB
Java
74 lines
2.9 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.channel;
|
|
|
|
import java.net.SocketAddress;
|
|
|
|
/**
|
|
* Represents the properties of a {@link Channel} implementation.
|
|
*/
|
|
public final class ChannelMetadata {
|
|
|
|
private final boolean hasDisconnect;
|
|
private final int defaultMaxMessagesPerRead;
|
|
|
|
/**
|
|
* Create a new instance
|
|
*
|
|
* @param hasDisconnect {@code true} if and only if the channel has the {@code disconnect()} operation
|
|
* that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)}
|
|
* again, such as UDP/IP.
|
|
*/
|
|
public ChannelMetadata(boolean hasDisconnect) {
|
|
this(hasDisconnect, 1);
|
|
}
|
|
|
|
/**
|
|
* Create a new instance
|
|
*
|
|
* @param hasDisconnect {@code true} if and only if the channel has the {@code disconnect()} operation
|
|
* that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)}
|
|
* again, such as UDP/IP.
|
|
* @param defaultMaxMessagesPerRead If a {@link MaxMessagesRecvByteBufAllocator} is in use, then this value will be
|
|
* set for {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead()}. Must be {@code > 0}.
|
|
*/
|
|
public ChannelMetadata(boolean hasDisconnect, int defaultMaxMessagesPerRead) {
|
|
if (defaultMaxMessagesPerRead <= 0) {
|
|
throw new IllegalArgumentException("defaultMaxMessagesPerRead: " + defaultMaxMessagesPerRead +
|
|
" (expected > 0)");
|
|
}
|
|
this.hasDisconnect = hasDisconnect;
|
|
this.defaultMaxMessagesPerRead = defaultMaxMessagesPerRead;
|
|
}
|
|
|
|
/**
|
|
* Returns {@code true} if and only if the channel has the {@code disconnect()} operation
|
|
* that allows a user to disconnect and then call {@link Channel#connect(SocketAddress)} again,
|
|
* such as UDP/IP.
|
|
*/
|
|
public boolean hasDisconnect() {
|
|
return hasDisconnect;
|
|
}
|
|
|
|
/**
|
|
* If a {@link MaxMessagesRecvByteBufAllocator} is in use, then this is the default value for
|
|
* {@link MaxMessagesRecvByteBufAllocator#maxMessagesPerRead()}.
|
|
*/
|
|
public int defaultMaxMessagesPerRead() {
|
|
return defaultMaxMessagesPerRead;
|
|
}
|
|
}
|