IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.engine
Interface IControllable

All Known Subinterfaces:
IActionQueue, IDispatcher, IQueue, IWorker

public interface IControllable


Method Summary
 void drain()
          Drain this IControllable's workload.
 boolean isPaused()
          Is it paused?
 boolean isRunning()
          Is this controllable object current active?
 void pause()
          Suspend processing.
 void resume()
          Resume processing.
 void shutdown()
          Stop processing.
 

Method Detail

pause

void pause()
Suspend processing.

Suspends processing by this IControllable.

Throws:
ControllableException - if the controllable is in a bad state or has been shut down

isPaused

boolean isPaused()
Is it paused?

Returns:
true if paused; falseotherwise
Throws:
ControllableException - if the controllable is in a bad state or has been shut down

resume

void resume()
Resume processing.

Throws:
ControllableException - if the controllable is in a bad state or has been shut down

shutdown

void shutdown()
Stop processing.


drain

void drain()
Drain this IControllable's workload.

To drain an IControllable is to keep it from accepting new work to do but continuing to process existing work.

drain() is similar to pause() in that work eventually stops, but they differ in that pause() stops executing immediately (after the current action completes) and drain() continues until it is done with all work (or data) assigned to it.

For example:

After an IControllable has been drained, it would probably be shutdown, but it could be resumed.

See Also:
IControllable.pause()

isRunning

boolean isRunning()
Is this controllable object current active?

Returns:
'true' if the controllable has been started but not completed; 'false' otherwise

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.