Motivation: Invoking ChannelHandlers is not free and can result in some overhead when the ChannelPipeline becomes very long. This is especially true if most handlers will just forward the call to the next handler in the pipeline. When the user extends Channel*HandlerAdapter we can easily detect if can just skip the handler and invoke the next handler in the pipeline directly. This reduce the overhead of dispatch but also reduce the call-stack in many cases. This backports https://github.com/netty/netty/pull/8723 and https://github.com/netty/netty/pull/8987 to 4.1 Modifications: Detect if we can skip the handler when walking the pipeline. Result: Reduce overhead for long pipelines. Benchmark (extraHandlers) Mode Cnt Score Error Units DefaultChannelPipelineBenchmark.propagateEventOld 4 thrpt 10 267313.031 ± 9131.140 ops/s DefaultChannelPipelineBenchmark.propagateEvent 4 thrpt 10 824825.673 ± 12727.594 ops/s
146 lines
5.0 KiB
Java
146 lines
5.0 KiB
Java
/*
|
|
* Copyright 2012 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;
|
|
|
|
import io.netty.channel.ChannelHandlerMask.Skip;
|
|
|
|
/**
|
|
* Abstract base class for {@link ChannelInboundHandler} implementations which provide
|
|
* implementations of all of their methods.
|
|
*
|
|
* <p>
|
|
* This implementation just forward the operation to the next {@link ChannelHandler} in the
|
|
* {@link ChannelPipeline}. Sub-classes may override a method implementation to change this.
|
|
* </p>
|
|
* <p>
|
|
* Be aware that messages are not released after the {@link #channelRead(ChannelHandlerContext, Object)}
|
|
* method returns automatically. If you are looking for a {@link ChannelInboundHandler} implementation that
|
|
* releases the received messages automatically, please see {@link SimpleChannelInboundHandler}.
|
|
* </p>
|
|
*/
|
|
public class ChannelInboundHandlerAdapter extends ChannelHandlerAdapter implements ChannelInboundHandler {
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelRegistered()} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelRegistered(ChannelHandlerContext ctx) throws Exception {
|
|
ctx.fireChannelRegistered();
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelUnregistered()} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelUnregistered(ChannelHandlerContext ctx) throws Exception {
|
|
ctx.fireChannelUnregistered();
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelActive()} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelActive(ChannelHandlerContext ctx) throws Exception {
|
|
ctx.fireChannelActive();
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelInactive()} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelInactive(ChannelHandlerContext ctx) throws Exception {
|
|
ctx.fireChannelInactive();
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelRead(Object)} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
|
|
ctx.fireChannelRead(msg);
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelReadComplete()} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
|
|
ctx.fireChannelReadComplete();
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireUserEventTriggered(Object)} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
|
|
ctx.fireUserEventTriggered(evt);
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireChannelWritabilityChanged()} to forward
|
|
* to the next {@link ChannelInboundHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
|
|
ctx.fireChannelWritabilityChanged();
|
|
}
|
|
|
|
/**
|
|
* Calls {@link ChannelHandlerContext#fireExceptionCaught(Throwable)} to forward
|
|
* to the next {@link ChannelHandler} in the {@link ChannelPipeline}.
|
|
*
|
|
* Sub-classes may override this method to change behavior.
|
|
*/
|
|
@Skip
|
|
@Override
|
|
@SuppressWarnings("deprecation")
|
|
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
|
|
throws Exception {
|
|
ctx.fireExceptionCaught(cause);
|
|
}
|
|
}
|