Difference between writing a ByteBuf and an ordinary Java Objects

Question

I noticed it is possible to eother write data which is an instance of ByteBuff or plain Java Objects when using Netty.

As can be seen in the HAProxyClient

On that file you have

HAProxyMessage message = new HAProxyMessage(
                    HAProxyProtocolVersion.V2, 
                    HAProxyCommand.PROXY, HAProxyProxiedProtocol.TCP4,
                    "127.0.0.1", 
                    "127.0.0.2", 
                    8000, 
                    9000
);

ch.writeAndFlush(message).sync();

Where a normal Java object, HAProxyMessage was written to the context. Still on the same file, you have:

ch.writeAndFlush(Unpooled.copiedBuffer("Hello World!", CharsetUtil.US_ASCII)).sync();

Where Unpooled.copiedBuffer is used to create the data to be written. This method returns a ByteBuf.

The question then is: what is the material difference (if any) between writing (or reading) a plan Java object and a ByteBuf

Answer 1

When you write a ByteBuf, the message does not need any conversion. When it is a Java Object, you need an encoder/decoder. Here you have the following:

• Encoder: https://github.com/netty/netty/blob/a60825c3b425892af9be3e9284677aa8a58faa6b/codec-haproxy/src/main/java/io/netty/handler/codec/haproxy/HAProxyMessageEncoder.java
• Decoder: https://github.com/netty/netty/blob/a60825c3b425892af9be3e9284677aa8a58faa6b/codec-haproxy/src/main/java/io/netty/handler/codec/haproxy/HAProxyMessageDecoder.java

They transform the Java Object to ByteBuf (Encoder) or reversely (Decoder).

The way you want to use one or the other depends on you current case:

• do you managed Java Object? Probably having a codec (Encoder/Decodec) is a good way.
• do you maneged simple data (bytestream, simple values...)? Probably managing directly ByteBuf is a good way. These are not the only relevant questions to decide for one or the other.

But finally, in Netty, everything is a ByteBuf.