dd6b7969b7
This pull request adds two new handler methods: discardInboundReadBytes(ctx) and discardOutboundReadBytes(ctx) to ChannelInboundByteHandler and ChannelOutboundByteHandler respectively. They are called between every inboundBufferUpdated() and flush() respectively. Their default implementation is to call discardSomeReadBytes() on their buffers and a user can override this behavior easily. For example, ReplayingDecoder.discardInboundReadBytes() looks like the following:
@Override
public void discardInboundReadBytes(ChannelHandlerContext ctx) throws Exception {
ByteBuf in = ctx.inboundByteBuffer();
final int oldReaderIndex = in.readerIndex();
super.discardInboundReadBytes(ctx);
final int newReaderIndex = in.readerIndex();
checkpoint -= oldReaderIndex - newReaderIndex;
}
If a handler, which has its own buffer index variable, extends ReplayingDecoder or ByteToMessageDecoder, the handler can also override discardInboundReadBytes() and adjust its index variable accordingly.
37 lines
1.3 KiB
Java
37 lines
1.3 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.buffer.ByteBuf;
|
|
|
|
/**
|
|
* {@link ChannelInboundHandler} which offers a {@link ByteBuf} to store inbound data in.
|
|
*
|
|
*/
|
|
public interface ChannelInboundByteHandler extends ChannelInboundHandler {
|
|
@Override
|
|
ByteBuf newInboundBuffer(ChannelHandlerContext ctx) throws Exception;
|
|
|
|
/**
|
|
* Discards the read bytes of the inbound buffer and optionally trims its unused portion to reduce memory
|
|
* consumption. The most common implementation of this method will look like the following:
|
|
* <pre>
|
|
* ctx.inboundByteBuffer().discardSomeReadBytes();
|
|
* </pre>
|
|
*/
|
|
void discardInboundReadBytes(ChannelHandlerContext ctx) throws Exception;
|
|
}
|