org.apache.mina.filter.codec.statemachine

Class FixedLengthDecodingState

java.lang.Object

org.apache.mina.filter.codec.statemachine.FixedLengthDecodingState

All Implemented Interfaces:

DecodingState

public abstract class FixedLengthDecodingState
extends java.lang.Object
implements DecodingState

A DecodingState which consumes all received bytes until a configured number of read bytes has been reached. Please note that this state can produce the buffer with less data if the associated session has been closed unexpectedly.

Version:

$Rev: 601994 $, $Date: 2007-12-07 05:58:00 +0100 (Fri, 07 Dec 2007) $

Author:

The Apache MINA Project (dev@mina.apache.org)

Constructor Summary

Constructors

Constructor and Description
FixedLengthDecodingState(int length) Constructs with a known decode length.

Method Summary

Modifier and Type	Method and Description
DecodingState	decode(IoBuffer in, ProtocolDecoderOutput out) Invoked when data is available for this state.
protected abstract DecodingState	finishDecode(IoBuffer readData, ProtocolDecoderOutput out)
DecodingState	finishDecode(ProtocolDecoderOutput out) Invoked when the associated IoSession is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedLengthDecodingState

public FixedLengthDecodingState(int length)

Constructs with a known decode length.

Parameters:

length - The decode length

Method Detail

decode

public DecodingState decode(IoBuffer in,
                            ProtocolDecoderOutput out)
                     throws java.lang.Exception

Description copied from interface: DecodingState

Invoked when data is available for this state.

Specified by:

decode in interface DecodingState

Throws:

java.lang.Exception

finishDecode

public DecodingState finishDecode(ProtocolDecoderOutput out)
                           throws java.lang.Exception

Description copied from interface: DecodingState

Invoked when the associated IoSession is closed.

Specified by:

finishDecode in interface DecodingState

Throws:

java.lang.Exception

finishDecode

protected abstract DecodingState finishDecode(IoBuffer readData,
                                              ProtocolDecoderOutput out)
                                       throws java.lang.Exception

Throws:

java.lang.Exception