io.netty.handler.codec.serialization

Class ObjectEncoder

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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOperationHandler, io.netty.channel.ChannelOutboundHandler, io.netty.channel.ChannelOutboundMessageHandler<Object>

@ChannelHandler.Sharable
public class ObjectEncoder
extends MessageToByteEncoder<Object>

An encoder which serializes a Java object into a ByteBuf.

Please note that the serialized form this encoder produces is not compatible with the standard ObjectInputStream. Please use ObjectDecoder or ObjectDecoderInputStream to ensure the interoperability with this encoder.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ObjectEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.buffer.ByteBuf out)
boolean	isEncodable(Object msg) Returns true if and only if the specified message can be encoded by this encoder.

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

ObjectEncoder

public ObjectEncoder()

Method Detail

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(io.netty.channel.ChannelHandlerContext ctx,
          Object msg,
          io.netty.buffer.ByteBuf out)
            throws Exception

Specified by:

encode in class MessageToByteEncoder<Object>

Throws:

Exception