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

java.lang.Object
  org.jboss.netty.handler.codec.serialization.ObjectEncoder

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler

@ChannelPipelineCoverage(value="all")
public class ObjectEncoder
extends Object
implements ChannelDownstreamHandler

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.

Unless there's a requirement for the interoperability with the standard object streams, it is recommended to use ObjectEncoder and ObjectDecoder rather than CompatibleObjectEncoder and CompatibleObjectDecoder.

Version:

$Rev:231 $, $Date:2008-06-12 16:44:50 +0900 (목, 12 6월 2008) $

Author:

The Netty Project (netty-dev@lists.jboss.org), Trustin Lee (tlee@redhat.com)

Constructor Summary

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

ObjectEncoder(int estimatedLength)
Creates a new encoder.

Method Summary

void	handleDownstream(ChannelHandlerContext context, ChannelEvent evt) Handles the specified downstream event.

Methods inherited from class java.lang.Object

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

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

handleDownstream

public void handleDownstream(ChannelHandlerContext context,
                             ChannelEvent evt)
                      throws Exception

Description copied from interface: ChannelDownstreamHandler

Handles the specified downstream event.

Specified by:

handleDownstream in interface ChannelDownstreamHandler

Parameters:

context - the context object for this handler

evt - the downstream event to process or intercept

Throws:

Exception