MaxMessagesReadHandleFactory (Netty5/Transport 5.0.0.Alpha5 API)

java.lang.Object
- io.netty5.channel.MaxMessagesReadHandleFactory

All Implemented Interfaces:

ReadHandleFactory

Direct Known Subclasses:

AdaptiveReadHandleFactory, FixedReadHandleFactory, ServerChannelReadHandleFactory
```
public abstract class MaxMessagesReadHandleFactory
extends Object
implements ReadHandleFactory
```
Base implementation of ReadHandleFactory which allows to limit the number of messages read per read loop.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected static class`	`MaxMessagesReadHandleFactory.MaxMessageReadHandle`	Focuses on enforcing the maximum messages per read condition for `MaxMessagesReadHandleFactory.MaxMessageReadHandle.lastRead(int, int, int)`.

Nested classes/interfaces inherited from interface io.netty5.channel.ReadHandleFactory
ReadHandleFactory.ReadHandle

Constructor Summary

Constructors
Modifier Constructor Description

protected MaxMessagesReadHandleFactory()

protected MaxMessagesReadHandleFactory(int maxMessagesPerRead)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`ReadHandleFactory.ReadHandle`	`newHandle(Channel channel)`	Creates a new handle for the given `Channel`.
`protected abstract MaxMessagesReadHandleFactory.MaxMessageReadHandle`	`newMaxMessageHandle(int maxMessagesPerRead)`	Creates a new `MaxMessagesReadHandleFactory.MaxMessageReadHandle` to use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MaxMessagesReadHandleFactory
```
protected MaxMessagesReadHandleFactory()
```
  - MaxMessagesReadHandleFactory
```
protected MaxMessagesReadHandleFactory(int maxMessagesPerRead)
```
- Method Detail
  - newHandle
```
public final ReadHandleFactory.ReadHandle newHandle(Channel channel)
```
    Description copied from interface: ReadHandleFactory
    
    Creates a new handle for the given Channel.
    
    Specified by:
    
    newHandle in interface ReadHandleFactory
    
    Parameters:
    
    channel - the Channel for which the ReadHandleFactory.ReadHandle is used.
  - newMaxMessageHandle
```
protected abstract MaxMessagesReadHandleFactory.MaxMessageReadHandle newMaxMessageHandle(int maxMessagesPerRead)
```
    Creates a new MaxMessagesReadHandleFactory.MaxMessageReadHandle to use.
    
    Parameters:
    
    maxMessagesPerRead - the maximum number of messages to read per read loop.
    
    Returns:
    
    the handle.