BaseTaskScheduler (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BaseTaskScheduler

All Implemented Interfaces:

TaskScheduler

Direct Known Subclasses:

ClientNameTaskScheduler, ComplexTaskScheduler, SimpleTaskScheduler
```
public abstract class BaseTaskScheduler
extends Object
implements TaskScheduler
```
This class is the abstract superclass for hydra task schedulers. It contains a basic implementation of the TaskScheduler interface.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`disconnect` Whether to disconnect from gemfire on normal exit
`protected boolean`	`haltIfBadResult` Whether to halt when a (non-hang) fatal task error occurs.
`protected com.gemstone.gemfire.LogWriter`	`log`
`protected String`	`name` The name of this scheduler
`protected String`	`purpose` The purpose of this scheduler
`protected Vector`	`tasks` The tasks for this scheduler
`protected String`	`termination` reason this scheduler is terminating
`protected Map`	`vms` The client vm records for this scheduler

Constructor Summary

Constructors
Constructor and Description
`BaseTaskScheduler(String name, Vector tasks, String purpose)` Creates a task scheduler by the given name for the purpose of executing the given set of tasks.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`assignTask(ClientRecord client, TestTask task)` Asks the client to execute the task.
`void`	`createClients(Map cds, Map tgs)` Asks this scheduler to create vm and client records based on the client descriptions and map clients to threadgroups.
`protected boolean`	`exceededMaxResultWaitSec(ClientRecord client, long now)` Returns true if the client is still busy and has run out of time.
`protected boolean`	`exceededMaxResultWaitSec(Collection clients, long now)` Returns true if any clients are still busy and have run out of time.
`protected boolean`	`exceededMaxResultWaitSec(long now)` Returns true if any clients are still busy and have run out of time.
`protected boolean`	`executedNormally()` Returns true if the scheduler executed normally up to this point.
`protected boolean`	`executedNormallyOrNoHaltOrder()` Returns true if the scheduler executed normally up to this point or should continue in spite of fatal task error.
`protected abstract boolean`	`executeTasks()` Executes the tasks using the existing clients.
`boolean`	`executeTasks(boolean haltIfBadResult, long maxResultWaitSec)` Executes the tasks for this scheduler using existing clients.
`protected static void`	`fakeKillResults(ClientVmRecord vm)` Called by dynamic stopper threads to fake task results for the busy clients in a killed vm so the scheduler will not wait for them to finish.
`protected int`	`getTsid()` Returns the task scheduler id.
`protected ClientVmRecord`	`getVm(Integer vmid)` Returns the client vm record with the given id.
`protected Map`	`getVms()` Returns the client vm records.
`protected boolean`	`hadDynamicActionError()` Returns true if there has been an error during a dynamic action.
`protected boolean`	`hadDynamicActionHang()` Returns true if there has been a hang during a dynamic action.
`protected boolean`	`hadFatalTaskErrorAndHaltOrder()` Returns true if any client has encountered a fatal task error and the test is configured to halt.
`protected boolean`	`hadStatMonitorError()` Returns true if a monitored condition was violated or there was an error in the statistics monitor.
`protected void`	`initClientRuntime()` Initializes client runtime state prior to task execution.
`protected void`	`initExecutionParameters(boolean haltIfBadResult, long maxResultWaitSec)` Initializes task execution fields.
`protected boolean`	`isFinished(ClientRecord client, long now)` Returns true if a client has finished its task or encountered a failure.
`protected void`	`pauseBlocking()` Used to pause a terminating scheduler when it is waiting for dynamic schedulers to complete.
`protected void`	`pauseScheduling()` Used to pause an active scheduler when it has had an unfruitful pass through the live client list.
`protected void`	`pauseWaiting()` Used to pause a terminating scheduler when it is waiting for currently busy clients to complete their tasks.
`protected void`	`printBlockingReport(long now)` Periodically logs that scheduler is waiting for dynamic actions to finish.
`void`	`printReport()` Asks this scheduler to log the result of executing its tasks, including the number of times the task was assigned and a summary of response times.
`protected void`	`printSchedulingReport(long now)` Periodically logs that scheduler is waiting for idle eligible clients.
`protected void`	`printWaitingReport(long now)` Periodically logs that scheduler is waiting for busy clients to finish.
`protected static void`	`processDynamicActionError(Throwable t)` Triggers the test to halt due to an error during a dynamic action.
`protected static void`	`reportResult(int tsid, int vmid, int tid, TestTaskResult result)` Called remotely by client threads to pass back task results.
`protected boolean`	`schedulerResult()` Returns the pass/fail outcome of running the scheduler and prints the reason the scheduler terminated.
`protected static void`	`setDynamicActionError(Throwable t)` Sets the global dynamic action error flag and local termination condition.
`protected static void`	`setDynamicActionHang(Throwable t)` Sets the global dynamic action hang flag and local termination condition.
`protected static void`	`setStatMonitorError(Throwable t)` Sets the global statistics monitor error flag and local termination condition.
`protected void`	`setTermination(String reason)` Sets the reason for terminating the scheduler.
`void`	`startClients()` Asks this scheduler to start clients previously created.
`void`	`startClientsForced()` Asks this scheduler to start clients previously created, regardless of whether there have been fatal task errors or hangs in earlier phases of the test.
`void`	`stopClients()` Asks this scheduler to stop the clients, rather than leaving them running for another scheduler to use later.
`protected long`	`waitForClientsToFinish()` Waits for clients in all vms to finish their tasks or encounter a failure.
`protected long`	`waitForClientsToFinish(Vector clients)` Waits for clients in a vm to finish their tasks or encounter a failure.
`protected long`	`waitForClientToFinish(ClientRecord client)` Waits for a client to finish its task or encounter a failure.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
    The name of this scheduler
  - vms
```
protected Map vms
```
    The client vm records for this scheduler
  - tasks
```
protected Vector tasks
```
    The tasks for this scheduler
  - purpose
```
protected String purpose
```
    The purpose of this scheduler
  - haltIfBadResult
```
protected boolean haltIfBadResult
```
    Whether to halt when a (non-hang) fatal task error occurs.
  - disconnect
```
protected boolean disconnect
```
    Whether to disconnect from gemfire on normal exit
  - termination
```
protected String termination
```
    reason this scheduler is terminating
  - log
```
protected com.gemstone.gemfire.LogWriter log
```
- Constructor Detail
  - BaseTaskScheduler
```
public BaseTaskScheduler(String name,
                         Vector tasks,
                         String purpose)
```
    Creates a task scheduler by the given name for the purpose of executing the given set of tasks.
    
    Parameters:
    
    name - a descriptive name of the tasks to use for logging
    
    tasks - the tasks to be scheduled
- Method Detail
  - createClients
```
public void createClients(Map cds,
                          Map tgs)
```
    Asks this scheduler to create vm and client records based on the client descriptions and map clients to threadgroups.
    
    Specified by:
    
    createClients in interface TaskScheduler
    
    Parameters:
    
    cds - the ClientDescription describes the client vms and threads
    
    tgs - the thread groups to map clients to.
  - startClients
```
public void startClients()
```
    Asks this scheduler to start clients previously created.
    
    Specified by:
    
    startClients in interface TaskScheduler
    
    Throws:
    
    HydraInternalException - if there are no clients, or any are running
    
    HydraTimeoutException - if the clients do not start within Prms.maxClientStartupWaitSec
  - startClientsForced
```
public void startClientsForced()
```
    Asks this scheduler to start clients previously created, regardless of whether there have been fatal task errors or hangs in earlier phases of the test.
    
    Specified by:
    
    startClientsForced in interface TaskScheduler
    
    Throws:
    
    HydraTimeoutException - if the clients do not start within Prms.maxClientStartupWaitSec
  - stopClients
```
public void stopClients()
```
    Asks this scheduler to stop the clients, rather than leaving them running for another scheduler to use later.
    
    Specified by:
    
    stopClients in interface TaskScheduler
    
    Throws:
    
    HydraTimeoutException - if the clients do not stop within Prms.maxClientShutdownWaitSec
  - executeTasks
```
public boolean executeTasks(boolean haltIfBadResult,
                            long maxResultWaitSec)
```
    Executes the tasks for this scheduler using existing clients.
    
    Specified by:
    
    executeTasks in interface TaskScheduler
    
    Parameters:
    
    haltIfBadResult - whether to terminate on a fatal task error
    
    maxResultWaitSec - the maximum amount of time to wait for any one task to complete
    
    Returns:
    
    true if there were no fatal task errors or hangs
    
    Throws:
    
    HydraInternalException - if there are no tasks or no clients
  - initExecutionParameters
```
protected void initExecutionParameters(boolean haltIfBadResult,
                                       long maxResultWaitSec)
```
    Initializes task execution fields.
  - initClientRuntime
```
protected void initClientRuntime()
```
    Initializes client runtime state prior to task execution. Also logs the number of logical clients and tasks.
  - executeTasks
```
protected abstract boolean executeTasks()
```
    Executes the tasks using the existing clients.
    
    Returns:
    
    true if there were no fatal task errors or hangs
  - getTsid
```
protected int getTsid()
```
    Returns the task scheduler id.
  - getVms
```
protected Map getVms()
```
    Returns the client vm records.
  - getVm
```
protected ClientVmRecord getVm(Integer vmid)
```
    Returns the client vm record with the given id.
  - assignTask
```
protected void assignTask(ClientRecord client,
                          TestTask task)
```
    Asks the client to execute the task. Issues the actual remote call.
  - waitForClientsToFinish
```
protected long waitForClientsToFinish()
```
    Waits for clients in all vms to finish their tasks or encounter a failure.
  - waitForClientsToFinish
```
protected long waitForClientsToFinish(Vector clients)
```
    Waits for clients in a vm to finish their tasks or encounter a failure.
  - waitForClientToFinish
```
protected long waitForClientToFinish(ClientRecord client)
```
    Waits for a client to finish its task or encounter a failure.
  - isFinished
```
protected boolean isFinished(ClientRecord client,
                             long now)
```
    Returns true if a client has finished its task or encountered a failure. If not, prints a report then pauses to avoid running hot.
  - hadFatalTaskErrorAndHaltOrder
```
protected boolean hadFatalTaskErrorAndHaltOrder()
```
    Returns true if any client has encountered a fatal task error and the test is configured to halt.
  - setStatMonitorError
```
protected static void setStatMonitorError(Throwable t)
```
    Sets the global statistics monitor error flag and local termination condition. This method allows the statistics monitors to halt the test.
  - hadStatMonitorError
```
protected boolean hadStatMonitorError()
```
    Returns true if a monitored condition was violated or there was an error in the statistics monitor.
  - processDynamicActionError
```
protected static void processDynamicActionError(Throwable t)
```
    Triggers the test to halt due to an error during a dynamic action.
  - setDynamicActionError
```
protected static void setDynamicActionError(Throwable t)
```
    Sets the global dynamic action error flag and local termination condition. This method allows dynamic scheduler threads to halt the test.
  - setDynamicActionHang
```
protected static void setDynamicActionHang(Throwable t)
```
    Sets the global dynamic action hang flag and local termination condition. This method allows dynamic scheduler threads to halt the test.
  - hadDynamicActionError
```
protected boolean hadDynamicActionError()
```
    Returns true if there has been an error during a dynamic action.
  - hadDynamicActionHang
```
protected boolean hadDynamicActionHang()
```
    Returns true if there has been a hang during a dynamic action.
  - exceededMaxResultWaitSec
```
protected boolean exceededMaxResultWaitSec(long now)
```
    Returns true if any clients are still busy and have run out of time.
  - exceededMaxResultWaitSec
```
protected boolean exceededMaxResultWaitSec(Collection clients,
                                           long now)
```
    Returns true if any clients are still busy and have run out of time.
  - exceededMaxResultWaitSec
```
protected boolean exceededMaxResultWaitSec(ClientRecord client,
                                           long now)
```
    Returns true if the client is still busy and has run out of time. If so, it also sets up termination, logs the hang, and prints process stacks.
  - setTermination
```
protected void setTermination(String reason)
```
    Sets the reason for terminating the scheduler.
  - executedNormallyOrNoHaltOrder
```
protected boolean executedNormallyOrNoHaltOrder()
```
    Returns true if the scheduler executed normally up to this point or should continue in spite of fatal task error.
  - executedNormally
```
protected boolean executedNormally()
```
    Returns true if the scheduler executed normally up to this point.
  - schedulerResult
```
protected boolean schedulerResult()
```
    Returns the pass/fail outcome of running the scheduler and prints the reason the scheduler terminated.
  - reportResult
```
protected static void reportResult(int tsid,
                                   int vmid,
                                   int tid,
                                   TestTaskResult result)
```
    Called remotely by client threads to pass back task results.
  - fakeKillResults
```
protected static void fakeKillResults(ClientVmRecord vm)
```
    Called by dynamic stopper threads to fake task results for the busy clients in a killed vm so the scheduler will not wait for them to finish.
  - printSchedulingReport
```
protected void printSchedulingReport(long now)
```
    Periodically logs that scheduler is waiting for idle eligible clients. Waits at least one round before reporting, then reports no more frequently than every 15 seconds.
  - pauseScheduling
```
protected void pauseScheduling()
```
    Used to pause an active scheduler when it has had an unfruitful pass through the live client list.
  - printWaitingReport
```
protected void printWaitingReport(long now)
```
    Periodically logs that scheduler is waiting for busy clients to finish. Waits at least one round before reporting, then reports no more frequently than every 15 seconds.
  - pauseWaiting
```
protected void pauseWaiting()
```
    Used to pause a terminating scheduler when it is waiting for currently busy clients to complete their tasks.
  - printBlockingReport
```
protected void printBlockingReport(long now)
```
    Periodically logs that scheduler is waiting for dynamic actions to finish. Waits at least one round before reporting, then reports no more frequently than every 15 seconds.
  - pauseBlocking
```
protected void pauseBlocking()
```
    Used to pause a terminating scheduler when it is waiting for dynamic schedulers to complete.
  - printReport
```
public void printReport()
```
    Asks this scheduler to log the result of executing its tasks, including the number of times the task was assigned and a summary of response times.
    
    Specified by:
    
    printReport in interface TaskScheduler

Class BaseTaskScheduler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

vms

tasks

purpose

haltIfBadResult

disconnect

termination

log

Constructor Detail

BaseTaskScheduler

Method Detail

createClients

startClients

startClientsForced

stopClients

executeTasks

initExecutionParameters

initClientRuntime

executeTasks

getTsid

getVms

getVm

assignTask

waitForClientsToFinish

waitForClientsToFinish

waitForClientToFinish

isFinished

hadFatalTaskErrorAndHaltOrder

setStatMonitorError

hadStatMonitorError

processDynamicActionError

setDynamicActionError

setDynamicActionHang

hadDynamicActionError

hadDynamicActionHang

exceededMaxResultWaitSec

exceededMaxResultWaitSec

exceededMaxResultWaitSec

setTermination

executedNormallyOrNoHaltOrder

executedNormally

schedulerResult

reportResult

fakeKillResults

printSchedulingReport

pauseScheduling

printWaitingReport

pauseWaiting

printBlockingReport

pauseBlocking

printReport