IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.packet.connection
Interface IConnectionPacket

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

public interface IConnectionPacket
extends IRecorderPacket

A packet carrying information related to a specific connection. The connection is represented as a couple (domain, id). Two different connections have different domain or IDs. Recorders having the notion of connection (and which handle more than one connection at a time) should produce packets that extend this interface.


Field Summary
static int DEFAULT_DOMAIN
          The domain ID for packets captured by a recorder which does not support the domain notion.
static String ID
           
static long NO_CONNECTION
          The return value of IConnectionPacket.getConnectionId() when the packet is not associated to a connection.
 
Method Summary
 long getConnectionId()
          Returns the ID of the connection that this packet was captured on.
 int getDomainId()
          Returns the domain ID that this packet was captured on.
 
Methods inherited from interface com.ibm.rational.test.lt.recorder.core.packet.IRecorderPacket
getEndTimestamp, getPacketType, getPacketVersion, getRecorderId, getSize, getStartTimestamp
 

Field Detail

ID

static final String ID
See Also:
Constant Field Values

DEFAULT_DOMAIN

static final int DEFAULT_DOMAIN
The domain ID for packets captured by a recorder which does not support the domain notion.

See Also:
Constant Field Values

NO_CONNECTION

static final long NO_CONNECTION
The return value of IConnectionPacket.getConnectionId() when the packet is not associated to a connection. Depending on the semantics of packets, the return value of IConnectionPacket.getDomainId() may or may not be significant. Packets that have a NO_CONNECTION connection ID are not considered to belong to any connection and are usually ignored by most converters and test generators. Returning NO_CONNECTION allows all implementation classes of a specific packet type to implement IConnectionPacket, even for those few packets that are not actually bound to a connection.

See Also:
Constant Field Values
Method Detail

getConnectionId

long getConnectionId()
Returns the ID of the connection that this packet was captured on. This ID is unique within a specific domain of a specific recorder.

Returns:
the ID of the connection that this packet was captured on, or IConnectionPacket.NO_CONNECTION if this packet is not tied to a specific connection.

getDomainId

int getDomainId()
Returns the domain ID that this packet was captured on. The domain notion is optional. A domain is abstract grouping notion that maps to a concrete segmentation of connections by a recorder. This ID is unique within a specific recorder.

Returns:
the domain ID that this packet was captured on. Returns IConnectionPacket.DEFAULT_DOMAIN if the recorder does not segment its connections across domains.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.