Package io.netty.contrib.handler.codec.serialization

Class CompatibleObjectEncoder

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

io.netty5.handler.codec.MessageToByteEncoder<Serializable>

io.netty.contrib.handler.codec.serialization.CompatibleObjectEncoder

All Implemented Interfaces:

io.netty5.channel.ChannelHandler

public class CompatibleObjectEncoder
extends io.netty5.handler.codec.MessageToByteEncoder<Serializable>

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

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

Constructor Summary

Constructors

Constructor	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	Description
protected io.netty5.buffer.Buffer	allocateBuffer(io.netty5.channel.ChannelHandlerContext ctx, Serializable serializable)
protected void	encode(io.netty5.channel.ChannelHandlerContext ctx, Serializable msg, io.netty5.buffer.Buffer out)
protected ObjectOutputStream	newObjectOutputStream(OutputStream out)	Creates a new ObjectOutputStream which wraps the specified OutputStream.

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

acceptOutboundMessage, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelExceptionCaught, channelInactive, channelInboundEvent, channelRead, channelReadComplete, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown

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

allocateBuffer

protected io.netty5.buffer.Buffer allocateBuffer(io.netty5.channel.ChannelHandlerContext ctx,
                                                 Serializable serializable)

Specified by:

allocateBuffer in class io.netty5.handler.codec.MessageToByteEncoder<Serializable>

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

encode

protected void encode(io.netty5.channel.ChannelHandlerContext ctx,
                      Serializable msg,
                      io.netty5.buffer.Buffer out)
               throws Exception

Specified by:

encode in class io.netty5.handler.codec.MessageToByteEncoder<Serializable>

Throws:

Exception