IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.logging
Interface ICache


public interface ICache


Field Summary
static int REALTIME
          the value to pass to setLevel() to turn off caching
 
Method Summary
 void close()
           
 void deleteFile()
          delete the cache file
 IReader getReader()
          Returns an object that can be used to read the cache file
 void setLevel(int level)
           
 void stopCaching()
          drain the queue and stop the thread.
 void stopCaching(boolean waitFlag)
          drain the queue and stop the thread.
 boolean write(com.ibm.rational.test.lt.kernel.logging.impl.AbstractHistory.TrackedExecutionEvent trackedEvent, int level)
          accepts TrackedExecutionEvent object and queues it for writing to the file.
 

Field Detail

REALTIME

static final int REALTIME
the value to pass to setLevel() to turn off caching

See Also:
Constant Field Values
Method Detail

write

boolean write(com.ibm.rational.test.lt.kernel.logging.impl.AbstractHistory.TrackedExecutionEvent trackedEvent,
              int level)
accepts TrackedExecutionEvent object and queues it for writing to the file. The cache thread will dequeue and write the results of trackedEvent.getEvent().toString() to the file. Returns true if the event was accepted and queued. Returns false if either the cache is stopping, stopped, or the level is greater than the cache level.

Parameters:
trackedEvent - the object to cache
level - the level of this data
Returns:
true if the event was accepted, false otherwise

getReader

IReader getReader()
Returns an object that can be used to read the cache file

Returns:
IReader

deleteFile

void deleteFile()
delete the cache file


stopCaching

void stopCaching()
drain the queue and stop the thread. While in the stopping state, write() returns false. Do not return until the queue is empty.


stopCaching

void stopCaching(boolean waitFlag)
drain the queue and stop the thread. While in the stopping state, write() returns false. If waitFlag is true, do not return until the queue is empty.

Parameters:
waitFlag -

close

void close()

setLevel

void setLevel(int level)

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.