IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.testgen.core.conversion
Interface IPacketConverterContext

All Superinterfaces:
IPacketAttachmentFactory

public interface IPacketConverterContext
extends IPacketAttachmentFactory

Provides the necessary information and operations for a IPacketConverter to operate.


Method Summary
 IConvertedPacketAttachment createPacketAttachment()
          Returns a new packet attachment that can be used to attach large data to an output packet.
 IRecorderPacketReference createPacketReference(IRecorderPacket packet)
          Creates a reference to the specified packet.
 IPacketReferenceStore createPacketStore()
          Creates a temporary storage area for packets that need to be retained by a converter, but may not all fit in memory.
 PacketConverterConfiguration getConfiguration()
          Returns the packet converter configuration.
 IPacketReferenceOutputStream getOutputStream()
          Returns the packet output stream that the converter should be used to emit the result of the conversion.
 RecorderConfiguration getRecorderConfiguration(short recorderId)
          Returns the recorder configuration of the recorder with the specified id.
 ITimeReference getTimeReference()
          Returns the time reference that allows to convert recording timestamps, expressed in an implementation-dependent but very accurate unit, to times expressed in milliseconds.
 void logMessage(com.ibm.rational.test.lt.recorder.core.util.LogMessageSeverity severity, String message)
          Logs a message about the conversion.
 

Method Detail

getConfiguration

PacketConverterConfiguration getConfiguration()
Returns the packet converter configuration.

Returns:
the packet converter configuration.

getTimeReference

ITimeReference getTimeReference()
Returns the time reference that allows to convert recording timestamps, expressed in an implementation-dependent but very accurate unit, to times expressed in milliseconds.

Returns:
the time reference

getOutputStream

IPacketReferenceOutputStream getOutputStream()
Returns the packet output stream that the converter should be used to emit the result of the conversion.

Returns:

createPacketStore

IPacketReferenceStore createPacketStore()
                                        throws IOException
Creates a temporary storage area for packets that need to be retained by a converter, but may not all fit in memory. Use a packet store as an alternative to a list of IRecorderPacketReference, which may not scale well with large recording sessions.

Returns:
A new packet store.
Throws:
IOException

createPacketReference

IRecorderPacketReference createPacketReference(IRecorderPacket packet)
Creates a reference to the specified packet.
Important: Note that a reference should be created only for packets generated by the converter. If the converter is provided with a packet reference and needs to output the same packet, it should output the same reference that was passed to it.

Parameters:
packet - A packet created by the converter.
Returns:
A new reference to the packet.

createPacketAttachment

IConvertedPacketAttachment createPacketAttachment()
Returns a new packet attachment that can be used to attach large data to an output packet.

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

logMessage

void logMessage(com.ibm.rational.test.lt.recorder.core.util.LogMessageSeverity severity,
                String message)
Logs a message about the conversion. This method may be invoked each time the converter needs to log an informational message about the pending conversion. The way a message will be presented to the user depends on its severity. Debug messages are usually not presented to the user and displayed only if the corresponding option has been enabled. Fatal messages, in addition to be presented to the user, will cause the conversion, and any process depending on it, to abort.

Parameters:
severity - The message severity
message - A message

getRecorderConfiguration

RecorderConfiguration getRecorderConfiguration(short recorderId)
Returns the recorder configuration of the recorder with the specified id. Each recorder packet carries the id of the recorder that issued it.

Parameters:
recorderId - A recorder id.
Returns:
The recorder configuration of the recorder with the specified id, or null if no recorder has the specified id.
See Also:
IRecorderPacket.getRecorderId()

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.