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

Interface IControllable

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      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:

        • drain() a queue - this action will cause the queue to stop accepting new data, but will continue to allow dequeueing until it is empty
        • drain() a worker - this action will cause the worker to continue executing the action on which it works, but will not take on any additional work

        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. 2013. All rights reserved.