com.ibm.rational.test.lt.kernel.action

Interface IKUserGroup

    • Method Detail

      • addUser

        boolean addUser(int startingGroupNum,
                      int startingGlobalNum)
        Add virtual user.

        Creates a virtual user within the UserGroup container. A call to runUsers() must be made to dispatch users added for execution.

        Parameters:
        startingGroupNum - This user's identifying number with this UserGroup.
        startingGlobalNum - This users' unique identifying number within this schedule run.
        Returns:
        trueUser added successfully. falseA problem was encountered adding this user. Consult the Problem Determination log for details.
      • setUserLevels

        boolean setUserLevels(int lumberjacks,
                            int historians,
                            int statisticians,
                            int armers)
        Set user levels.

        Sets the number of virtual users that will be report execution history, providing execution statistics, writing problem determination log data, and providing ARM (Application Response Measurement) data.

        Parameters:
        lumberjacks - Number of logging users.
        historians - Number of users providing execution history.
        statisticians - Number of users providing statistics data.
        armers - Number of users providing ARM data.
        Returns:
        true if all levels set successfully. false if there was a problem setting levels. Consult the Problem Determination log for more details.
      • runUsers

        void runUsers()
        Start virtual user test execution.

        Starts execution of virtual users previously added.

      • runUsers

        boolean runUsers(com.ibm.rational.test.lt.kernel.impl.KStaggerPair[] stagger)
        Run virtual users.

        Starts execution of virtual users added to the engine.

        Parameters:
        stagger - Array of startup sequences made up of two integers. First integer is the number of users to start. Second integer is a delay value in milliseconds to wait before starting each user.
        Returns:
        true if the users are all running.
      • createTesterWorkload

        IContainer createTesterWorkload(IContainer parent)
        Define workload.

        Produces the container of actions which make up the workload for a given virtual user in this user group.

        Parameters:
        parent - The virtual user which owns this workload.
        Returns:
        Workload container.
      • setStaggerDelay

        void setStaggerDelay(int s)
        Specify stagger value to be used when launching users.

        The stagger delay is the amount of time in milliseconds that should be paused in between starting execution of virtual users.

        Parameters:
        s - Number of milliseconds to pause between starting users.
      • getVirtualUsersActive

        int getVirtualUsersActive()
        Get virtual users active.
        Returns:
        Number of users active.
      • setLongRunMode

        void setLongRunMode(boolean mode)
        Set (enable/disable) the long run mode
        Parameters:
        value - the new value
      • getLongRunMode

        boolean getLongRunMode()
        Get the long run mode value
      • setLongRunLimit

        void setLongRunLimit(int limit)
        Set (enable/disable) the long run mode test limit
        Parameters:
        value - the new value
      • getLongRunLimit

        int getLongRunLimit()
        Get the long run mode test limit
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.