org.apache.mina.filter.codec.statemachine
Class ConsumeToCrLfDecodingState

java.lang.Object
  extended by org.apache.mina.filter.codec.statemachine.ConsumeToCrLfDecodingState
All Implemented Interfaces:
DecodingState

public abstract class ConsumeToCrLfDecodingState
extends Object
implements DecodingState

DecodingState which consumes all bytes until a CRLF has been encountered.

Version:
$Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (Do, 26 Jun 2008) $
Author:
The Apache MINA Project (dev@mina.apache.org)

Constructor Summary
ConsumeToCrLfDecodingState()
          Creates a new instance.
 
Method Summary
 DecodingState decode(IoBuffer in, ProtocolDecoderOutput out)
          Invoked when data is available for this state.
protected abstract  DecodingState finishDecode(IoBuffer product, ProtocolDecoderOutput out)
          Invoked when this state has reached a CRLF.
 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

ConsumeToCrLfDecodingState

public ConsumeToCrLfDecodingState()
Creates a new instance.

Method Detail

decode

public DecodingState decode(IoBuffer in,
                            ProtocolDecoderOutput out)
                     throws Exception
Description copied from interface: DecodingState
Invoked when data is available for this state.

Specified by:
decode in interface DecodingState
Parameters:
in - the data to be decoded.
out - used to write decoded objects.
Returns:
the next state if a state transition was triggered (use this for loop transitions) or null if the state machine has reached its end.
Throws:
Exception - if the read data violated protocol specification.

finishDecode

public DecodingState finishDecode(ProtocolDecoderOutput out)
                           throws Exception
Invoked when the associated IoSession is closed. This method is useful when you deal with protocols which don't specify the length of a message (e.g. HTTP responses without content-length header). Implement this method to process the remaining data that DecodingState.decode(IoBuffer, ProtocolDecoderOutput) method didn't process completely.

Specified by:
finishDecode in interface DecodingState
Parameters:
out - used to write decoded objects.
Returns:
the next state if a state transition was triggered (use this for loop transitions) or null if the state machine has reached its end.
Throws:
Exception - if the read data violated protocol specification.

finishDecode

protected abstract DecodingState finishDecode(IoBuffer product,
                                              ProtocolDecoderOutput out)
                                       throws Exception
Invoked when this state has reached a CRLF.

Parameters:
product - the read bytes including the CRLF.
out - the current ProtocolDecoderOutput used to write decoded messages.
Returns:
the next state if a state transition was triggered (use this for loop transitions) or null if the state machine has reached its end.
Throws:
Exception - if the read data violated protocol specification.


Copyright © 2004-2009 Apache MINA Project. All Rights Reserved.