io.netty.handler.codec.serialization

Class CompatibleObjectEncoder

java.lang.Object

io.netty.channel.ChannelOperationHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.channel.ChannelOutboundMessageHandlerAdapter<I>

io.netty.handler.codec.MessageToByteEncoder<Object>

io.netty.handler.codec.serialization.CompatibleObjectEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOperationHandler, ChannelOutboundHandler, ChannelOutboundMessageHandler<Object>

public class CompatibleObjectEncoder
extends MessageToByteEncoder<Object>

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

Methods

Modifier and Type	Method and Description
void	encode(ChannelHandlerContext ctx, Object msg, ByteBuf out)
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this encoder.
protected ObjectOutputStream	newObjectOutputStream(OutputStream out) Creates a new ObjectOutputStream which wraps the specified OutputStream.

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

flush

Methods inherited from class io.netty.channel.ChannelOutboundMessageHandlerAdapter

newOutboundBuffer

Methods inherited from class io.netty.channel.ChannelOperationHandlerAdapter

afterAdd, afterRemove, beforeAdd, beforeRemove, bind, close, connect, deregister, disconnect, exceptionCaught, userEventTriggered

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.ChannelOperationHandler

bind, close, connect, deregister, disconnect

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeAdd, beforeRemove, exceptionCaught, userEventTriggered

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 ObjectOutputStream newObjectOutputStream(OutputStream out)
                                            throws Exception

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

Throws:

Exception

isEncodable

public boolean isEncodable(Object msg)
                    throws Exception

Description copied from class: MessageToByteEncoder

Returns true if and only if the specified message can be encoded by this encoder.

Overrides:

isEncodable in class MessageToByteEncoder<Object>

Parameters:

msg - the message

Throws:

Exception

encode

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

Specified by:

encode in class MessageToByteEncoder<Object>

Throws:

Exception