BackgroundChannelHandler (venice API)

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - com.linkedin.alpini.netty4.handlers.ChannelInitializer<io.netty.channel.Channel>
    - - com.linkedin.alpini.netty4.handlers.BackgroundChannelHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
```
@Sharable
public class BackgroundChannelHandler
extends ChannelInitializer<io.netty.channel.Channel>
```
Created by acurtis on 5/4/17.

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

Constructor Summary

Constructors
Constructor	Description
`BackgroundChannelHandler(io.netty.channel.ChannelHandler... channelHandler)`
`BackgroundChannelHandler(java.util.function.Supplier<io.netty.channel.ChannelHandler[]> channelHandlerSupplier)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`initChannel(io.netty.channel.Channel ch)`	This method will be called once the `Channel` was registered.

Methods inherited from class com.linkedin.alpini.netty4.handlers.ChannelInitializer
channelRegistered, currentContext, exceptionCaught, handlerAdded, handlerRemoved

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

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

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

- Constructor Detail
  - BackgroundChannelHandler
```
public BackgroundChannelHandler(io.netty.channel.ChannelHandler... channelHandler)
```
  - BackgroundChannelHandler
```
public BackgroundChannelHandler(@Nonnull
                                java.util.function.Supplier<io.netty.channel.ChannelHandler[]> channelHandlerSupplier)
```
- Method Detail
  - initChannel
```
protected void initChannel(io.netty.channel.Channel ch)
                    throws java.lang.Exception
```
    Description copied from class: ChannelInitializer
    
    This method will be called once the Channel was registered. After the method returns this instance will be removed from the ChannelPipeline of the Channel.
    
    Specified by:
    
    initChannel in class ChannelInitializer<io.netty.channel.Channel>
    
    Parameters:
    
    ch - the Channel which was registered.
    
    Throws:
    
    java.lang.Exception - is thrown if an error occurs. In that case it will be handled by ChannelInitializer.exceptionCaught(ChannelHandlerContext, Throwable) which will by default close the Channel.