io.netty.handler.codec.serialization

Class CompatibleObjectEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<java.io.Serializable>

io.netty.handler.codec.serialization.CompatibleObjectEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

public class CompatibleObjectEncoder
extends MessageToByteEncoder<java.io.Serializable>

An encoder which serializes a Java object into a ByteBuf (interoperability version).

This encoder is interoperable with the standard Java object streams such as ObjectInputStream and ObjectOutputStream.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
CompatibleObjectEncoder() Creates a new instance with the reset interval of 16.
CompatibleObjectEncoder(int resetInterval) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext ctx, java.io.Serializable msg, ByteBuf out) Encode a message into a ByteBuf.
protected java.io.ObjectOutputStream	newObjectOutputStream(java.io.OutputStream out) Creates a new ObjectOutputStream which wraps the specified OutputStream.

Methods inherited from class io.netty.handler.codec.MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

CompatibleObjectEncoder

public CompatibleObjectEncoder()

Creates a new instance with the reset interval of 16.

CompatibleObjectEncoder

public CompatibleObjectEncoder(int resetInterval)

Creates a new instance.

Parameters:

resetInterval - the number of objects between ObjectOutputStream.reset(). 0 will disable resetting the stream, but the remote peer will be at the risk of getting OutOfMemoryError in the long term.

Method Detail

newObjectOutputStream

protected java.io.ObjectOutputStream newObjectOutputStream(java.io.OutputStream out)
                                                    throws java.lang.Exception

Creates a new ObjectOutputStream which wraps the specified OutputStream. Override this method to use a subclass of the ObjectOutputStream.

Throws:

java.lang.Exception

encode

protected void encode(ChannelHandlerContext ctx,
                      java.io.Serializable msg,
                      ByteBuf out)
               throws java.lang.Exception

Description copied from class: MessageToByteEncoder

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

Specified by:

encode in class MessageToByteEncoder<java.io.Serializable>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

java.lang.Exception - is thrown if an error occurs