cf171ff525
Motiviation: The current read loops don't fascilitate reading a maximum amount of bytes. This capability is useful to have more fine grain control over how much data is injested. Modifications: - Add a setMaxBytesPerRead(int) and getMaxBytesPerRead() to ChannelConfig - Add a setMaxBytesPerIndividualRead(int) and getMaxBytesPerIndividualRead to ChannelConfig - Add methods to RecvByteBufAllocator so that a pluggable scheme can be used to control the behavior of the read loop. - Modify read loop for all transport types to respect the new RecvByteBufAllocator API Result: The ability to control how many bytes are read for each read operation/loop, and a more extensible read loop.
36 lines
1.5 KiB
Java
36 lines
1.5 KiB
Java
/*
|
|
* Copyright 2015 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;
|
|
|
|
/**
|
|
* {@link RecvByteBufAllocator} that limits the number of read operations that will be attempted when a read operation
|
|
* is attempted by the event loop.
|
|
*/
|
|
public interface MaxMessagesRecvByteBufAllocator extends RecvByteBufAllocator {
|
|
/**
|
|
* Returns the maximum number of messages to read per read loop.
|
|
* a {@link ChannelInboundHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event.
|
|
* If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
|
|
*/
|
|
int maxMessagesPerRead();
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
MaxMessagesRecvByteBufAllocator maxMessagesPerRead(int maxMessagesPerRead);
|
|
}
|