org.openfast.codec

Class FastDecoder

java.lang.Object

org.openfast.codec.FastDecoder

All Implemented Interfaces:

Coder

public class FastDecoder
extends Object
implements Coder

A FastDecoder is the core class for reading and decoding FAST messages from any input stream. This class can be used instead of MessageInputStream when working with FAST messages embedded in other protocols.

NOTE: The context object that is used to construct a FastDecoder should not be shared with any other decoders or encoders.

Constructor Summary

Constructors

Constructor and Description
FastDecoder(Context context, InputStream in) Construct a new FastDecoder with a context and input stream.

Method Summary

Methods

Modifier and Type	Method and Description
Message	readMessage() Read the next FAST message from the input stream.
Message	readMessage(int offset) Helper method that can be used to read past a non-FAST message header.
void	reset() Reset the FAST dictionary.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastDecoder

public FastDecoder(Context context,
           InputStream in)

Construct a new FastDecoder with a context and input stream.

Parameters:

context - The context containg templates to be used in decoding and where FAST dictionary data will be stored

in - The input stream to read messages from

Method Detail

readMessage

public Message readMessage()
                    throws FastException

Read the next FAST message from the input stream.

Returns:

an object representing the decoded FAST message

Throws:

FastException - if a decoding error occurs or the end of the input stream has been reached

readMessage

public Message readMessage(int offset)

Helper method that can be used to read past a non-FAST message header.

Parameters:

offset - number of bytes in the stream to skip

Returns:

the decoded FAST message encountered after skipping the offset.

reset

public void reset()

Reset the FAST dictionary.

Specified by:

reset in interface Coder