AutoReadFlowControlHandler (Ldaptive 2.3.2 API)

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - org.ldaptive.transport.netty.AutoReadFlowControlHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
```
public class AutoReadFlowControlHandler
extends io.netty.channel.ChannelDuplexHandler
```
Keeps a counter of messages that have been sent down the pipeline. That counter is decremented whenever a read is requested. A read is only propagated to the channel when all messages have completed. This handler is intended to be used with NettyConnection.AutoReadEventHandler.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields
Modifier and Type Field Description

protected Logger logger
Logger for this class.

private AtomicInteger messageCount
Number of messages in the pipeline.

Constructor Summary

Constructors
Constructor Description

AutoReadFlowControlHandler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)`
`void`	`read(io.netty.channel.ChannelHandlerContext ctx)`

Methods inherited from class io.netty.channel.ChannelDuplexHandler
bind, close, connect, deregister, disconnect, flush, write

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, handlerAdded, handlerRemoved, isSharable

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

Methods inherited from interface io.netty.channel.ChannelHandler
handlerAdded, handlerRemoved

- Field Detail
  - logger
```
protected final Logger logger
```
    Logger for this class.
  - messageCount
```
private final AtomicInteger messageCount
```
    Number of messages in the pipeline.
- Constructor Detail
  - AutoReadFlowControlHandler
```
public AutoReadFlowControlHandler()
```
- Method Detail
  - channelRead
```
public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception
```
    Specified by:
    
    channelRead in interface io.netty.channel.ChannelInboundHandler
    
    Overrides:
    
    channelRead in class io.netty.channel.ChannelInboundHandlerAdapter
    
    Throws:
    
    Exception
  - read
```
public void read(io.netty.channel.ChannelHandlerContext ctx)
          throws Exception
```
    Specified by:
    
    read in interface io.netty.channel.ChannelOutboundHandler
    
    Overrides:
    
    read in class io.netty.channel.ChannelDuplexHandler
    
    Throws:
    
    Exception