org.snf4j.websocket.extensions.compress

Class PerMessageDeflateDecoder

java.lang.Object

org.snf4j.websocket.extensions.compress.PerMessageDeflateDecoder

All Implemented Interfaces:

ICodec<Frame,Frame>, IDecoder<Frame,Frame>, IEventDrivenCodec

public class PerMessageDeflateDecoder
extends Object

The per-message implementation of deflate decoder (decompressor).

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
PerMessageDeflateDecoder(boolean noContext) Constructs a per-message deflate decoder with specified context takeover control.
PerMessageDeflateDecoder(boolean noContext, int minInflateBound) Constructs a per-message deflate decoder with specified context takeover control and minimum upper bound on the decompressed size.

Method Summary

Modifier and Type	Method and Description
void	added(ISession session, ICodecPipeline pipeline) Signals that the codec has been added to the pipeline associated with a session.
void	decode(ISession session, Frame frame, List<Frame> out) Decodes data from one type to another one.
void	event(ISession session, SessionEvent event) Signals a session event to the codec.
Class<Frame>	getInboundType() Returns the type of the accepted inbound objects.
Class<Frame>	getOutboundType() Returns the type of the produced outbound objects.
void	removed(ISession session, ICodecPipeline pipeline) Signals that the codec has been removed from the pipeline associated with a session.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.codec.ICodec

getInboundType, getOutboundType

Methods inherited from interface org.snf4j.core.codec.IEventDrivenCodec

added, event, removed

Constructor Detail

PerMessageDeflateDecoder

public PerMessageDeflateDecoder(boolean noContext,
                                int minInflateBound)

Constructs a per-message deflate decoder with specified context takeover control and minimum upper bound on the decompressed size.

Parameters:

noContext - true to prevent from using the context takeover

minInflateBound - determines the minimum upper bound on the decompressed size. Setting this parameter to proper value may speed up the decompression of highly compressed data.

PerMessageDeflateDecoder

public PerMessageDeflateDecoder(boolean noContext)

Constructs a per-message deflate decoder with specified context takeover control.

Parameters:

noContext - true to prevent from using the context takeover

Method Detail

decode

public void decode(ISession session,
                   Frame frame,
                   List<Frame> out)
            throws Exception

Description copied from interface: IDecoder

Decodes data from one type to another one.

Decoders that do not produce an output (i.e. the O parameter is Void) cannot change the object passed as the data argument. They should not also store it for future use as its state can be changed.

The above limitations regarding the data argument do not apply to decoders that produce an output.

Specified by:

decode in interface IDecoder<Frame,Frame>

Parameters:

session - the ISession which the passed data belongs to

frame - the data to decode to another one

out - the List to which the decoded data should be added, or null if O is Void

Throws:

Exception - is thrown, if an error occur

getInboundType

public Class<Frame> getInboundType()

Description copied from interface: ICodec

Returns the type of the accepted inbound objects.

Specified by:

getInboundType in interface ICodec<Frame,Frame>

Returns:

the type of the inbound objects

getOutboundType

public Class<Frame> getOutboundType()

Description copied from interface: ICodec

Returns the type of the produced outbound objects.

Specified by:

getOutboundType in interface ICodec<Frame,Frame>

Returns:

the type of the outbound objects

added

public void added(ISession session,
                  ICodecPipeline pipeline)

Description copied from interface: IEventDrivenCodec

Signals that the codec has been added to the pipeline associated with a session.

Specified by:

added in interface IEventDrivenCodec

Parameters:

session - the session the pipeline is associated with

pipeline - the pipeline the codec has been added to

event

public void event(ISession session,
                  SessionEvent event)

Description copied from interface: IEventDrivenCodec

Signals a session event to the codec.

Specified by:

event in interface IEventDrivenCodec

Parameters:

session - the session which state is changing

event - the session event

removed

public void removed(ISession session,
                    ICodecPipeline pipeline)

Description copied from interface: IEventDrivenCodec

Signals that the codec has been removed from the pipeline associated with a session.

Specified by:

removed in interface IEventDrivenCodec

Parameters:

session - the session the pipeline is associated with

pipeline - the pipeline the codec has been removed from