net.grinder.console.client

Interface ConsoleConnection

public interface ConsoleConnection

Console API.

Warning: This API is under development and not stable. It will change.

Author:

Philip Aston

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the connection.
int	getNumberOfAgents() How many agents are connected?
void	resetRecording() Reset the console recording.
void	resetWorkerProcesses() Reset all the worker processes.
void	startRecording() Start the console recording.
void	startWorkerProcesses(GrinderProperties properties) Start all the worker processes.
void	stopAgents() Stop all agent processes.
void	stopRecording() Stop the console recording.

Method Detail

close

void close()

Close the connection.

startRecording

void startRecording()
                    throws ConsoleConnectionException

Start the console recording.

Throws:

ConsoleConnectionException - If a communication error occurred.

stopRecording

void stopRecording()
                   throws ConsoleConnectionException

Stop the console recording.

Throws:

ConsoleConnectionException - If a communication error occurred.

resetRecording

void resetRecording()
                    throws ConsoleConnectionException

Reset the console recording.

Throws:

ConsoleConnectionException - If a communication error occurred.

getNumberOfAgents

int getNumberOfAgents()
                      throws ConsoleConnectionException

How many agents are connected?

Returns:

The number of agents.

Throws:

ConsoleConnectionException - If a communication error occurred.

stopAgents

void stopAgents()
                throws ConsoleConnectionException

Stop all agent processes.

Throws:

ConsoleConnectionException - If a communication error occurred.

startWorkerProcesses

void startWorkerProcesses(GrinderProperties properties)
                          throws ConsoleConnectionException

Start all the worker processes.

Parameters:

properties - Properties that override the agents' local properties.

Throws:

ConsoleConnectionException - If a communication error occurred.

resetWorkerProcesses

void resetWorkerProcesses()
                          throws ConsoleConnectionException

Reset all the worker processes.

Throws:

ConsoleConnectionException - If a communication error occurred.