134 lines
4.9 KiB
Java
134 lines
4.9 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;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@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.
|
|
*/
|
|
@Override
|
|
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
|
|
throws Exception {
|
|
ctx.fireExceptionCaught(cause);
|
|
}
|
|
}
|