public Class MarshallingEncoder

Class Inheritance

extends MessageToByteEncoder<Object>

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelOutboundHandlerAdapter
io.netty.handler.codec.MessageToByteEncoder
io.netty.handler.codec.marshalling.MarshallingEncoder

Annotations

@Sharable

Imports

io.netty.buffer.ByteBuf, io.netty.channel.ChannelHandler.Sharable, .ChannelHandlerContext, io.netty.handler.codec.MessageToByteEncoder, org.jboss.marshalling.Marshaller

MessageToByteEncoder implementation which uses JBoss Marshalling to marshal an Object. Be aware that this encoder is not compatible with an other client that just use JBoss Marshalling as it includes the size of every Object that gets serialized in front of the Object itself. Use this with MarshallingDecoder See JBoss Marshalling website for more information

Field Summary

Modifier and Type	Field and Description
private static final byte[]	LENGTH_PLACEHOLDER
private final MarshallerProvider	provider

Constructor Summary

Access	Constructor and Description
public	MarshallingEncoder(MarshallerProvider the `MarshallerProvider` to use provider) Creates a new encoder.

Method Summary

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to ctx, Object the message to encode msg, ByteBuf the `ByteBuf` into which the encoded message will be written out) Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode. Encode a message into a `ByteBuf`.

Inherited from io.netty.handler.codec.MessageToByteEncoder:: acceptOutboundMessage allocateBuffer isPreferDirect write

Field Detail

LENGTH_PLACEHOLDER	back to summary
private static final byte[] LENGTH_PLACEHOLDER

provider	back to summary
private final MarshallerProvider provider

Constructor Detail

MarshallingEncoder back to summary

MarshallingEncoder	back to summary
public MarshallingEncoder(MarshallerProvider provider) Creates a new encoder. Parameters provider:MarshallerProvider the `MarshallerProvider` to use

public MarshallingEncoder(MarshallerProvider provider)

Creates a new encoder.

Parameters

provider:MarshallerProvider: the MarshallerProvider to use

Method Detail

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, Object msg, ByteBuf out) throws Exception Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode. Doc from io.netty.handler.codec.MessageToByteEncoder.encode. Encode a message into a `ByteBuf`. This method will be called for each written message that can be handled by this encoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to msg:Object the message to encode out:ByteBuf the `ByteBuf` into which the encoded message will be written Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void encode(ChannelHandlerContext ctx, Object msg, ByteBuf out) throws Exception

Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode.

Doc from io.netty.handler.codec.MessageToByteEncoder.encode.

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToByteEncoder belongs to
msg:Object: the message to encode
out:ByteBuf: the ByteBuf into which the encoded message will be written

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs