IBM Rational Performance Tester SDK

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

All Superinterfaces:
IPacketAttachmentFactory

public interface IPacketOutputStream
extends IPacketAttachmentFactory

An output stream of recorder packets. This class allows to write recorder packets and create attachments that must be referenced by recorder packets.


Method Summary
 void close()
          Closes the output stream.
 IPacketAttachment createPacketAttachment()
          Creates a packet attachment.
 void writePacket(IRecorderPacket packet)
          Writes a packet to the stream.
 

Method Detail

writePacket

void writePacket(IRecorderPacket packet)
                 throws IOException
Writes a packet to the stream.

Parameters:
packet - A recorder packet.
Throws:
IOException

createPacketAttachment

IPacketAttachment createPacketAttachment()
Creates a packet attachment. A packet attachment provides a way to store large data without holding the whole data in memory. The returned packet attachment has an open output stream that must be closed by the caller. Any packet attachment stream must be closed before invoking the writer's IPacketOutputStream.close() method. In order to be able to retrieve the packet attachment upon reading, the packet attachment must be referenced by one or more recorder packets stored in the same output stream.

Specified by:
createPacketAttachment in interface IPacketAttachmentFactory
Returns:
A new packet attachment.

close

void close()
           throws IOException
Closes the output stream. No more packet can be written after this call.

Throws:
IOException

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.