org.jboss.netty.handler.codec.serialization

Class ObjectEncoder

java.lang.Object

org.jboss.netty.handler.codec.oneone.OneToOneEncoder

org.jboss.netty.handler.codec.serialization.ObjectEncoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

@ChannelHandler.Sharable
public class ObjectEncoder
extends OneToOneEncoder

An encoder which serializes a Java object into a ChannelBuffer.

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 org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
private int	estimatedLength
private static byte[]	LENGTH_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
ObjectEncoder() Creates a new encoder with the estimated length of 512 bytes.
ObjectEncoder(int estimatedLength) Creates a new encoder.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	encode(ChannelHandlerContext ctx, Channel channel, java.lang.Object msg) Transforms the specified message into another message and return the transformed message.

Methods inherited from class org.jboss.netty.handler.codec.oneone.OneToOneEncoder

doEncode, handleDownstream

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH_PLACEHOLDER

private static final byte[] LENGTH_PLACEHOLDER

estimatedLength

private final int estimatedLength

Constructor Detail

ObjectEncoder

public ObjectEncoder()

Creates a new encoder with the estimated length of 512 bytes.

ObjectEncoder

public ObjectEncoder(int estimatedLength)

Creates a new encoder.

Parameters:

estimatedLength - the estimated byte length of the serialized form of an object. If the length of the serialized form exceeds this value, the internal buffer will be expanded automatically at the cost of memory bandwidth. If this value is too big, it will also waste memory bandwidth. To avoid unnecessary memory copy or allocation cost, please specify the properly estimated value.

Method Detail

encode

protected java.lang.Object encode(ChannelHandlerContext ctx,
                                  Channel channel,
                                  java.lang.Object msg)
                           throws java.lang.Exception

Description copied from class: OneToOneEncoder

Transforms the specified message into another message and return the transformed message. Note that you can not return null, unlike you can in OneToOneDecoder.decode(ChannelHandlerContext, Channel, Object); you must return something, at least ChannelBuffers.EMPTY_BUFFER.

Specified by:

encode in class OneToOneEncoder

Throws:

java.lang.Exception