Package org.jboss.netty.handler.codec.compression

Class ZlibDecoder

java.lang.Object

org.jboss.netty.handler.codec.oneone.OneToOneDecoder

org.jboss.netty.handler.codec.compression.ZlibDecoder

All Implemented Interfaces:

ChannelHandler, ChannelUpstreamHandler

public class ZlibDecoder
extends OneToOneDecoder

Decompresses a ChannelBuffer using the deflate algorithm.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	dictionary
private boolean	finished
private final com.jcraft.jzlib.ZStream	z

Constructor Summary

Constructors

Constructor	Description
ZlibDecoder()	Creates a new instance with the default wrapper (ZlibWrapper.ZLIB).
ZlibDecoder(byte[] dictionary)	Creates a new instance with the specified preset dictionary.
ZlibDecoder(ZlibWrapper wrapper)	Creates a new instance with the specified wrapper.

Method Summary

Modifier and Type	Method	Description
protected Object	decode(ChannelHandlerContext ctx, Channel channel, Object msg)	Transforms the specified received message into another message and return the transformed message.
boolean	isClosed()	Returns true if and only if the end of the compressed stream has been reached.

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

handleUpstream

Methods inherited from class java.lang.Object

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

Field Details

z

private final com.jcraft.jzlib.ZStream z

dictionary

private byte[] dictionary

finished

private volatile boolean finished

Constructor Details

ZlibDecoder

public ZlibDecoder()

Creates a new instance with the default wrapper (ZlibWrapper.ZLIB).

Throws:

CompressionException - if failed to initialize zlib

ZlibDecoder

public ZlibDecoder(ZlibWrapper wrapper)

Creates a new instance with the specified wrapper.

Throws:

CompressionException - if failed to initialize zlib

ZlibDecoder

public ZlibDecoder(byte[] dictionary)

Creates a new instance with the specified preset dictionary. The wrapper is always ZlibWrapper.ZLIB because it is the only format that supports the preset dictionary.

Throws:

CompressionException - if failed to initialize zlib

Method Details

isClosed

public boolean isClosed()

Returns true if and only if the end of the compressed stream has been reached.

decode

protected Object decode(ChannelHandlerContext ctx,
 Channel channel,
 Object msg)
                 throws Exception

Description copied from class: OneToOneDecoder

Transforms the specified received message into another message and return the transformed message. Return null if the received message is supposed to be discarded.

Specified by:

decode in class OneToOneDecoder

Throws:

Exception