IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.packet
Interface IRecorderPacket

All Superinterfaces:
Serializable
All Known Subinterfaces:
ICloseConnectionPacket, IConnectionPacket, IDataConnectionPacket, IOpenConnectionPacket, IReceiveConnectionPacket, IRecorderAnnotationPacket, ISendConnectionPacket

public interface IRecorderPacket
extends Serializable

A recorder packet represents the atomic piece of information captured by a recorder. A packet has two timing information (the time at which the piece of information started being captured, and the time at which the capture was complete). It also provides a size estimate for evaluating the recorder workload. Any other information is protocol-specific and defined in implementing classes. The interface requires that implementations do implement Serializable. A packet must be serializable using java serialization. In order to flawlessly work, a packet should contain only serializable fields, and should not reference objects that are not related to the information that should be serialized (unless the field is transient).


Method Summary
 long getEndTimestamp()
          Returns the time (in the recording framework clock) when the packet information was completely captured.
 String getPacketType()
          Returns the packet type id that this class implements.
 int getPacketVersion()
          Returns the packet version.
 short getRecorderId()
          Returns the unique (within the session) id of the recorder that issued the packet.
 long getSize()
          Returns a size estimate (in bytes) of the piece of information captured by the packet.
 long getStartTimestamp()
          Returns the time (in the recording framework clock) when the packet information started being captured.
 

Method Detail

getStartTimestamp

long getStartTimestamp()
Returns the time (in the recording framework clock) when the packet information started being captured.

Returns:
the time (in the recording framework clock) when the packet information started being captured.

getEndTimestamp

long getEndTimestamp()
Returns the time (in the recording framework clock) when the packet information was completely captured.

Returns:
the time (in the recording framework clock) when the packet information was completely captured.

getSize

long getSize()
Returns a size estimate (in bytes) of the piece of information captured by the packet.

Returns:
a size estimate (in bytes) of the piece of information captured by the packet.

getPacketType

String getPacketType()
Returns the packet type id that this class implements. Packet types are declared through the extension point com.ibm.rational.test.lt.recorder.core.recorderPacket. The implementation class must reside in the same plugin, or in another plugin provided that the declaring plugin has a class-access to the implementation class.

Returns:
the packet type id that this class implements.

getPacketVersion

int getPacketVersion()
Returns the packet version. Packets defined before this method was introduced are implicitly assigned version 1. If no serialization-breaking change has occurred since then, this method should return 1. Any time a serialization-breaking change occurs on any packet defined in the same plugin, this version should be incremented by 1 for all packet implementations. This version is used in future releases to handle packet upgrading when loading packets serialized with a previous version.

Returns:
The packet version, a strictly positive integer.

getRecorderId

short getRecorderId()
Returns the unique (within the session) id of the recorder that issued the packet.

Returns:
the unique (within the session) id of the recorder that issued the packet.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.