Control Parameters

CompositionPause

Click to fully pause a composition. A full pause pauses everything. All users, even existing users, pause what they are doing, and all activity (sending, etc.) is paused. Alternately, use Ramp Pause. Ramp pausing and full pausing can be done at any time, and can overlap, partially or fully. A full pause is performed with the Pause button on the Player Control.

CompositionStop

Stop conditionally terminates a composition that is still responsive while preserving its data stream. When Stop is clicked, message sends are halted and unwritten test data is presented. For larger tests, there will be some additional time before results appear.

CompositionAbort

Terminates the Composition as if there were an error and gives up writing the result. It is otherwise identical to CompositionStop.

RampPause

Pauses the Composition’s "ramp", if any, as if the user had pressed the "pause ramp" button. Note that this merely starts the ramp pausing. The ramp will not actually be completely paused until all portions of the Composition on all servers have paused the ramp. This method may be called at any time, including when the ramp is already paused or pausing, or when it is resuming. "Ramp up" is defined as Track parallel repeating with an "interval."

RampResume

Resumes the Composition's "ramp", if any, as if the user had pressed the "resume ramp" button. This merely starts the ramp resuming. The ramp will not actually be completely resumed until all portions of the Composition on all servers have resumed the ramp. This method may be called at any time, including when the ramp is not paused or pausing, or when it is already resuming. "Ramp" is defined as Track parallel repeating with an "interval". ContainerEnd Terminates the Container at the control insertion point as if there were an error. The message and detail text given in the parameters are inserted into the Result object. ContainerStopRepeating Terminates any subsequent repeats of the container in which the control resides.