0e4c073bcf
Motivation: ByteToMessageDecoder requires using an intermediate List to put results into. This intermediate list adds overhead (memory/CPU) which grows as the number of objects increases. This overhead can be avoided by directly propagating events through the ChannelPipeline via ctx.fireChannelRead(...). This also makes the semantics more clear and allows us to keep track if we need to call ctx.read() in all cases. Modifications: - Remove List from the method signature of ByteToMessageDecoder.decode(...) and decodeLast(...) - Adjust all sub-classes - Adjust unit tests - Fix javadocs. Result: Adjust ByteToMessageDecoder as noted in https://github.com/netty/netty/issues/8525.
98 lines
3.2 KiB
Java
98 lines
3.2 KiB
Java
/*
|
|
* Copyright 2014 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.handler.codec;
|
|
|
|
import io.netty.buffer.ByteBuf;
|
|
import io.netty.buffer.Unpooled;
|
|
import io.netty.channel.ChannelHandler;
|
|
import io.netty.channel.ChannelHandlerContext;
|
|
import io.netty.channel.embedded.EmbeddedChannel;
|
|
import org.junit.Test;
|
|
|
|
import static org.junit.Assert.*;
|
|
|
|
public class ByteToMessageCodecTest {
|
|
|
|
@Test(expected = IllegalStateException.class)
|
|
public void testSharable() {
|
|
new InvalidByteToMessageCodec();
|
|
}
|
|
|
|
@Test(expected = IllegalStateException.class)
|
|
public void testSharable2() {
|
|
new InvalidByteToMessageCodec2();
|
|
}
|
|
|
|
@Test
|
|
public void testForwardPendingData() {
|
|
ByteToMessageCodec<Integer> codec = new ByteToMessageCodec<Integer>() {
|
|
@Override
|
|
protected void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out) throws Exception {
|
|
out.writeInt(msg);
|
|
}
|
|
|
|
@Override
|
|
protected void decode(ChannelHandlerContext ctx, ByteBuf in) throws Exception {
|
|
if (in.readableBytes() >= 4) {
|
|
ctx.fireChannelRead(in.readInt());
|
|
}
|
|
}
|
|
};
|
|
|
|
ByteBuf buffer = Unpooled.buffer();
|
|
buffer.writeInt(1);
|
|
buffer.writeByte('0');
|
|
|
|
EmbeddedChannel ch = new EmbeddedChannel(codec);
|
|
assertTrue(ch.writeInbound(buffer));
|
|
ch.pipeline().remove(codec);
|
|
assertTrue(ch.finish());
|
|
assertEquals(1, (int) ch.readInbound());
|
|
|
|
ByteBuf buf = ch.readInbound();
|
|
assertEquals(Unpooled.wrappedBuffer(new byte[]{'0'}), buf);
|
|
buf.release();
|
|
assertNull(ch.readInbound());
|
|
assertNull(ch.readOutbound());
|
|
}
|
|
|
|
@ChannelHandler.Sharable
|
|
private static final class InvalidByteToMessageCodec extends ByteToMessageCodec<Integer> {
|
|
InvalidByteToMessageCodec() {
|
|
super(true);
|
|
}
|
|
|
|
@Override
|
|
protected void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out) throws Exception { }
|
|
|
|
@Override
|
|
protected void decode(ChannelHandlerContext ctx, ByteBuf in) throws Exception { }
|
|
}
|
|
|
|
@ChannelHandler.Sharable
|
|
private static final class InvalidByteToMessageCodec2 extends ByteToMessageCodec<Integer> {
|
|
InvalidByteToMessageCodec2() {
|
|
super(Integer.class, true);
|
|
}
|
|
|
|
@Override
|
|
protected void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out) throws Exception { }
|
|
|
|
@Override
|
|
protected void decode(ChannelHandlerContext ctx, ByteBuf in) throws Exception { }
|
|
}
|
|
}
|