Class RendezvousManager

Rendezvous Management

The Rendezvous Manager allows you to:

• Release a set number of Virtual Users detained at a specific rendezvous point
• Release all Virtual Users detained at a specific rendezvous
• Release all Virtual Users detained at all rendezvous
• Enable or disable a rendezvous
• Find out if a rendezvous is enabled or disabled
• Find out if a specific rendezvous point exists in one of the Virtual Users

The Rendezvous Manager acts on the test runtime globally, however many Load Generators are in use. Please note the following points on the way Rendezvous function:

• An order issued by the Rendezvous Manager is disseminated to all the Load Generators involved in playing the scenario.
• When concurrent orders are issued, the last order issued takes precedence over the others.

Example: Given that there are 3 Load Generators, (G1, G2 and G3). On G1, a Virtual User JavaScript action calls the following code:

context.rendezvousManager.setEnabled("rendezvous",false);

G1, G2 and G3 will then disable the Rendezvous named "rendezvous": all Generators obey the order issued by G1.

Synopsis

 public class RendezvousManager {
  // Public Constructors
  public RendezvousManager();
  // Public Methods
  public Boolean hasRendezvous(String RDVName);
  public Boolean isEnabled(String RDVName);
  public void setEnabled(String RDVName,
                         Boolean isEnabled);
  public void unblock(String RDVName);
  public void unblock(String RDVName,
                      int virtualUserCount);
  public void unblockAll();
}

hasRendezvous(String)

public Boolean hasRendezvous(String RDVName);

Parameters

• RDVName
  rendezvous name
• return
  Boolean value corresponding to the rendezvous ' existence

Indicates the existence of a rendezvous by returning a Boolean value.

This method returns:

• TRUE if the scenario contains the specified rendezvous (enabled or not).
• FALSE if the scenario does not contain the specified rendezvous .
• FALSE if the rendezvous does not exist.

isEnabled(String)

public Boolean isEnabled(String RDVName);

Parameters

• RDVName
• return
  Boolean value corresponding to the rendezvous state

Indicates the state of a rendezvous by returning a Boolean value.

This method returns:

• TRUE if the rendezvous exists and is enabled.
• FALSE if the rendezvous exists and is disabled.
• FALSE if the rendezvous does not exist.

When the specified rendezvous does not exist, an error is thrown and the script execution is stopped.

setEnabled(String, Boolean)

public void setEnabled(String RDVName,
                       Boolean isEnabled);

Parameters

• RDVName
  rendezvous name
• isEnabled
  Boolean value of the new rendezvous state

Enables or disables a given rendezvous .

Disabling a rendezvous has the following consequences:

• Virtual Users arriving at the rendezvous after it has been disabled are not detained.
• The Virtual Users that were previously detained at the rendezvous remain detained until their release (by the rendezvous policy or after timeout).

When the specified rendezvous does not exist, an error is thrown and the script execution is stopped.

unblock(String)

public void unblock(String RDVName);

Parameters

• RDVName
  Rendezvous name

Releases all Virtual Users detained at the specified Rendezvous at that precise moment in time.

Any Virtual User arriving at the Rendezvous after the method is called are detained.

When the specified Rendezvous does not exist, an error is thrown and the script execution is stopped.

unblock(String, int)

public void unblock(String RDVName,
                    int virtualUserCount);

Parameters

• RDVName
  Rendezvous name
• virtualUserCount
  number of Virtual Users to be released. A negative number unblock all Virtual Users (equivalent to unblock(RDVName)).

Releases a set number of Virtual Users detained at the specified Rendezvous. The Virtual Users are released on a FIFO (first in - first out) basis: the first Virtual User to arrive at the Rendezvous is the first to be released.

The number of Virtual Users released is spread among the Generators according to their load.

There are some special cases:

• The specified Rendezvous does not exist: an error is thrown and the script execution is stopped.
• The number of Virtual Users to be released is greater than the number of Virtual Users detained: NeoLoad releases the number of Virtual Users detained
• The number of users specified is less or equal to 0: an error is thrown and the script execution is stopped.

unblockAll()

public void unblockAll();

Releases all Virtual Users detained at that precise moment in time, whatever the Rendezvous at which they are detained.

Any Virtual User arriving at the Rendezvous after the method is called are detained.

Home