Class ConsumeToTerminatorDecodingState
- java.lang.Object
-
- org.apache.mina.filter.codec.statemachine.ConsumeToTerminatorDecodingState
-
- All Implemented Interfaces:
DecodingState
public abstract class ConsumeToTerminatorDecodingState extends Object implements DecodingState
DecodingState
which consumes all bytes until a fixed (ASCII) character is reached. The terminator is skipped.- Author:
- Apache MINA Project
-
-
Constructor Summary
Constructors Constructor Description ConsumeToTerminatorDecodingState(byte terminator)
Creates a new instance using the specified terminator character.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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 the terminator byte.DecodingState
finishDecode(ProtocolDecoderOutput out)
Invoked when the associatedIoSession
is closed.
-
-
-
Method Detail
-
decode
public DecodingState decode(IoBuffer in, ProtocolDecoderOutput out) throws Exception
Invoked when data is available for this state.- Specified by:
decode
in interfaceDecodingState
- 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) ornull
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 associatedIoSession
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 thatDecodingState.decode(IoBuffer, ProtocolDecoderOutput)
method didn't process completely.- Specified by:
finishDecode
in interfaceDecodingState
- Parameters:
out
- used to write decoded objects.- Returns:
- the next state if a state transition was triggered (use
this
for loop transitions) ornull
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 the terminator byte.- Parameters:
product
- the read bytes not including the terminator.out
- the currentProtocolDecoderOutput
used to write decoded messages.- Returns:
- the next state if a state transition was triggered (use
this
for loop transitions) ornull
if the state machine has reached its end. - Throws:
Exception
- if the read data violated protocol specification.
-
-