IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.core.extensibility
Interface IRecordingComponentContext

All Known Subinterfaces:
IClientContext, IRecorderContext

public interface IRecordingComponentContext

A generic context for recording components delegates. The context provides a log to log trace messages (errors, warnings, debug messages), and a mechanism for the delegate to send messages to the user.


Method Summary
 long currentTime()
          Returns a value that corresponds to the current time.
 void dispatchMessage(Message message)
          Dispatches a message to other recording components.
 short getComponentUniqueId()
          Returns the unique ID, within the current recording session, of the recording component.
 IRecorderLog getLog()
          Returns an instance of a logger that can be used by the delegate to log messages, including errors and exceptions.
 ITimeReference getTimeReference()
          Returns the time reference that allows to convert back and forth time expressed in the recording session clock and times expressed in milliseconds.
 

Method Detail

getLog

IRecorderLog getLog()
Returns an instance of a logger that can be used by the delegate to log messages, including errors and exceptions.

Returns:
an instance of a logger that can be used by the delegate to log messages, including errors and exceptions.

dispatchMessage

void dispatchMessage(Message message)
Dispatches a message to other recording components. The message is distributed to the destination(s) specified in message.

Parameters:
message - A message.

currentTime

long currentTime()
Returns a value that corresponds to the current time. All recorders and clients share the same clock, and the values obtained using this method can be compared to establish an ordering between events.

Returns:
the current time.

getTimeReference

ITimeReference getTimeReference()
Returns the time reference that allows to convert back and forth time expressed in the recording session clock and times expressed in milliseconds.

Returns:
the time reference.

getComponentUniqueId

short getComponentUniqueId()
Returns the unique ID, within the current recording session, of the recording component.

Returns:
The recording component unique ID within the recording session.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.