<h2>org.das2.qstream.StreamHandler</h2><p>This describes an object that is able to receive a stream from StreamTool.readStream, which breaks the stream up into descriptors and packets. This was copied from das2's das2stream library to create QStream, which is to replace it. See http://das2.org/wiki/index.php/Das2/QStreams</p> <hr> <a name="packet"></a> <h2>packet</h2> packet( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/PacketDescriptor.html'>org.das2.qstream.PacketDescriptor</a> pd, <a href='https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html'>java.nio.ByteBuffer</a> data ) → void <p>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!</p> <h3>Parameters</h3> pd - PacketDescriptor describing the data. <br> data - ByteBuffer containing the data. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=packet&unscoped_q=packet">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamHandler.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamHandler.html#packet">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamHandler.java">[view source]</a> <br> <br> <hr> <a name="packetDescriptor"></a> <h2>packetDescriptor</h2> packetDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/PacketDescriptor.html'>org.das2.qstream.PacketDescriptor</a> pd ) → void <p>description of a new packet type. This packetDescriptor will also be sent as packets of data are received.</p> <h3>Parameters</h3> pd - a PacketDescriptor <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=packetDescriptor&unscoped_q=packetDescriptor">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamHandler.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamHandler.html#packetDescriptor">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamHandler.java">[view source]</a> <br> <br> <hr> <a name="streamClosed"></a> <h2>streamClosed</h2> streamClosed( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamDescriptor.html'>org.das2.qstream.StreamDescriptor</a> sd ) → void <p>indicates the stream end is encountered.</p> <h3>Parameters</h3> sd - a StreamDescriptor <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=streamClosed&unscoped_q=streamClosed">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamHandler.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamHandler.html#streamClosed">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamHandler.java">[view source]</a> <br> <br> <hr> <a name="streamComment"></a> <h2>streamComment</h2> streamComment( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamComment.html'>org.das2.qstream.StreamComment</a> sd ) → void <p>comments on the stream.</p> <h3>Parameters</h3> sd - a StreamComment <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=streamComment&unscoped_q=streamComment">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamHandler.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamHandler.html#streamComment">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamHandler.java">[view source]</a> <br> <br> <hr> <a name="streamDescriptor"></a> <h2>streamDescriptor</h2> streamDescriptor( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamDescriptor.html'>org.das2.qstream.StreamDescriptor</a> sd ) → void <p>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.</p> <h3>Parameters</h3> sd - a StreamDescriptor <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=streamDescriptor&unscoped_q=streamDescriptor">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamHandler.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamHandler.html#streamDescriptor">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamHandler.java">[view source]</a> <br> <br> <hr> <a name="streamException"></a> <h2>streamException</h2> streamException( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qstream/StreamException.html'>org.das2.qstream.StreamException</a> se ) → void <p>This is used to indicate an exception occurred in the source.</p> <h3>Parameters</h3> se - a StreamException <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=streamException&unscoped_q=streamException">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/qstream/StreamHandler.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/qstream/StreamHandler.html#streamException">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/qstream/StreamHandler.java">[view source]</a> <br> <br>