org.das2.qstream

Class FormatStreamHandler

java.lang.Object

org.das2.qstream.FormatStreamHandler

All Implemented Interfaces:

StreamHandler

public class FormatStreamHandler
extends java.lang.Object
implements StreamHandler

Writes the stream based on the messages sent to it. This overlaps with the SimpleStreamFormatter, but was needed to support streams. The SimpleStreamFormatter took a QDataSet and formatted it. This formats based on the callbacks. Note the library was poorly designed, and this is pretty simple because most of the hard work is buried within the StreamDescriptor. StreamDescriptor should be simplified, and the code should be moved to here.

Constructor Summary

Constructors

Constructor and Description
FormatStreamHandler()

Method Summary

Modifier and Type	Method and Description
StreamDescriptor	createStreamDescriptor(java.lang.String name, boolean asciiTypes, boolean isBigEndian) create a stream descriptor packet.
void	packet(PacketDescriptor pd, java.nio.ByteBuffer data) receive a data packet from the stream.
void	packetDescriptor(PacketDescriptor pd) description of a new packet type.
void	setOutputStream(java.io.OutputStream outs)
void	setWritableByteChannel(java.nio.channels.WritableByteChannel outs)
void	streamClosed(StreamDescriptor sd) indicates the stream end is encountered.
void	streamComment(StreamComment se) comments on the stream.
void	streamDescriptor(StreamDescriptor sd) initial description of the stream.
void	streamException(StreamException se) This is used to indicate an exception occurred in the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatStreamHandler

public FormatStreamHandler()

Method Detail

setOutputStream

public void setOutputStream(java.io.OutputStream outs)

setWritableByteChannel

public void setWritableByteChannel(java.nio.channels.WritableByteChannel outs)

createStreamDescriptor

public StreamDescriptor createStreamDescriptor(java.lang.String name,
                                               boolean asciiTypes,
                                               boolean isBigEndian)

create a stream descriptor packet. TODO: createPacketDescriptor. See SerialStreamFormatter for examples of how this would be done.

Parameters:

name -

asciiTypes -

isBigEndian -

Returns:

streamDescriptor

public void streamDescriptor(StreamDescriptor sd)
                      throws StreamException

Description copied from interface: StreamHandler

initial description of the stream. This contains global properties of the stream. TODO: should codes expect only one of these? I think most probably do, but the spec says we should be able to pick up in the middle, implying that steamDescriptors may be resent.

Specified by:

streamDescriptor in interface StreamHandler

Throws:

StreamException

packetDescriptor

public void packetDescriptor(PacketDescriptor pd)
                      throws StreamException

Description copied from interface: StreamHandler

description of a new packet type. This packetDescriptor will also be sent as packets of data are received.

Specified by:

packetDescriptor in interface StreamHandler

Throws:

StreamException

packet

public void packet(PacketDescriptor pd,
                   java.nio.ByteBuffer data)
            throws StreamException

Description copied from interface: StreamHandler

receive a data packet from the stream. The packet descriptor is used to describe the packet contents, and the ByteBuffer contains the bytes. The byte buffer will have its position at the beginning of the data, and the limit will be the end of the data. Note for filters, the buffer must be reset!

Specified by:

packet in interface StreamHandler

Parameters:

pd - PacketDescriptor describing the data.

data - ByteBuffer containing the data.

Throws:

StreamException - when something is wrong with the content of the stream.

streamClosed

public void streamClosed(StreamDescriptor sd)
                  throws StreamException

Description copied from interface: StreamHandler

indicates the stream end is encountered.

Specified by:

streamClosed in interface StreamHandler

Throws:

StreamException

streamException

public void streamException(StreamException se)
                     throws StreamException

Description copied from interface: StreamHandler

This is used to indicate an exception occurred in the source.

Specified by:

streamException in interface StreamHandler

Throws:

StreamException

streamComment

public void streamComment(StreamComment se)
                   throws StreamException

Description copied from interface: StreamHandler

comments on the stream.

Specified by:

streamComment in interface StreamHandler

Throws:

StreamException