IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.io
Interface IPacketInputStream

All Known Subinterfaces:
IPacketReferenceInputStream

public interface IPacketInputStream

An input stream of recorder packets.


Method Summary
 void close()
          Closes this input stream.
 IPacketAttachment getPartialPacketAttachment(IPacketAttachment attachment, InputStream packetAttachmentInputStream)
          Returns a packet attachment whose content is the not-consumed part of another attachment input stream obtained through this packet input stream.
 IRecorderPacket readPacket()
          Returns the next packet in the stream.
 

Method Detail

readPacket

IRecorderPacket readPacket()
                           throws IOException,
                                  ClassNotFoundException
Returns the next packet in the stream.

Returns:
The next packet, or null if the end of stream has been reached.
Throws:
IOException - Any exception thrown by the underlying I/O layer.
ClassNotFoundException - If a packet could not be read because of an unresolved packet type (usually because the plugin declaring the packet type is missing).

getPartialPacketAttachment

IPacketAttachment getPartialPacketAttachment(IPacketAttachment attachment,
                                             InputStream packetAttachmentInputStream)
Returns a packet attachment whose content is the not-consumed part of another attachment input stream obtained through this packet input stream.

Parameters:
attachment - An attachment obtained through this packet input stream.
packetAttachmentInputStream - An input stream obtained from the attachment.
Returns:
A new packet attachment.

close

void close()
           throws IOException
Closes this input stream. The stream cannot be used any more after this call.

Throws:
IOException - Any exception thrown by the underlying I/O layer.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.