1 /*
2 * Copyright 2015 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.channel;
17
18 /**
19 * {@link RecvBufferAllocator} that limits the number of read operations that will be attempted when a read operation
20 * is attempted by the event loop.
21 */
22 public interface MaxMessagesRecvBufferAllocator extends RecvBufferAllocator {
23 /**
24 * Returns the maximum number of messages to read per read loop.
25 * a {@link ChannelHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event.
26 * If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
27 */
28 int maxMessagesPerRead();
29
30 /**
31 * Sets the maximum number of messages to read per read loop.
32 * If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
33 */
34 MaxMessagesRecvBufferAllocator maxMessagesPerRead(int maxMessagesPerRead);
35 }