hydra

Interface TaskScheduler

All Known Implementing Classes:

BaseTaskScheduler, ClientNameLockStepTaskScheduler, ClientNameTaskScheduler, ComplexConcurrentTaskScheduler, ComplexRoundRobinTaskScheduler, ComplexSerialTaskScheduler, ComplexTaskScheduler, DynamicConcurrentTaskScheduler, DynamicSerialTaskScheduler, SimpleConcurrentTaskScheduler, SimpleSerialTaskScheduler, SimpleTaskScheduler

public interface TaskScheduler

Interface for task schedulers.

Method Summary

Modifier and Type	Method and Description
void	createClients(Map cds, Map tgs) Asks the scheduler to create vm and client records based on the client descriptions and map clients to threadgroups.
boolean	executeTasks(boolean haltIfBadResult, long maxResultWaitSec) Asks the scheduler to execute its tasks using the existing clients.
void	printReport() Asks the scheduler to log the result of executing its tasks.
void	startClients() Asks the scheduler to start clients previously created but not running.
void	startClientsForced() Asks the scheduler to start clients previously created.
void	stopClients() Asks the scheduler to stop the clients, rather than leaving them running for another scheduler to use later.

Method Detail

createClients

void createClients(Map cds,
                   Map tgs)

Asks the scheduler to create vm and client records based on the client descriptions and map clients to threadgroups.

Parameters:

cds - the ClientDescription describes the client vms and threads

tgs - the thread groups to map clients to.

startClients

void startClients()

Asks the scheduler to start clients previously created but not running.

Throws:

HydraInternalException - if there are running clients

HydraTimeoutException - if the clients do not start within Prms.maxClientStartupWaitSec

startClientsForced

void startClientsForced()

Asks the scheduler to start clients previously created. Does not complain if there are running clients, but does remove them from the active list.

Throws:

HydraTimeoutException - if the clients do not start within Prms.maxClientStartupWaitSec

stopClients

void stopClients()

Asks the scheduler to stop the clients, rather than leaving them running for another scheduler to use later.

Throws:

HydraTimeoutException - if the clients do not stop within Prms.maxClientShutdownWaitSec

executeTasks

boolean executeTasks(boolean haltIfBadResult,
                     long maxResultWaitSec)

Asks the scheduler to execute its tasks using the existing clients.

Parameters:

haltIfBadResult - whether to stop on a fatal task error.

maxResultWaitSec - the maximum amount of time to wait for any one task to complete.

Returns:

true if all tasks completed within the time limit and without error.

Throws:

HydraInternalException - if there are tasks, but no existing clients

printReport

void printReport()

Asks the scheduler to log the result of executing its tasks.