Terminators (GemFire XD Java API Documentation)

java.lang.Object
- cacheperf.Terminators

```
public class Terminators
extends Object
```
Contains static methods suitable for use as terminators. All terminators should be kept brief for performance runs.
A warmup terminator is a public static boolean method that returns true when a client thread is considered to be "warmed up". It is executed with a configurable frequency until it returns true, after which it is no longer invoked.
A task terminator is a public static boolean method that returns true when a client thread is considered to be "done" with a task. It is executed with a configurable frequency until it returns true, at which time the client thread issues a StopSchedulingTaskOnClientOrder to stop work on the task and prevent being scheduled with the task in future.
A batch terminator is a public static void method that is executed by a client thread at the end of each batch of operations.

See Also:

CachePerfPrms

Constructor Summary

Constructors
Constructor and Description

Terminators()

Constructors
Constructor and Description
`Terminators()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`terminateAndSignalOnTrimSeconds(CachePerfClient c)` Returns true when a client has done the operation for `CachePerfPrms.trimSeconds` seconds.
`static boolean`	`terminateOnBatchSeconds(CachePerfClient c)` Returns true when a client has done the operation for `CachePerfPrms.batchSeconds` seconds.
`static boolean`	`terminateOnBatchSize(CachePerfClient c)` Returns true when a client has done `CachePerfPrms.batchSize` of the operation.
`static boolean`	`terminateOnGetInitialImageComplete(CachePerfClient c)` Returns true when the shared counter in `getInitialImage.InitImageBB.getInitialImagesCompleted` is non-zero.
`static boolean`	`terminateOnGetInitialImageInProgress(CachePerfClient c)` Returns true when the shared counter in `getInitialImage.InitImageBB.getInitialImagesInProgress` is non-zero.
`static boolean`	`terminateOnLRUEvictions(CachePerfClient c)` Returns true when each stat archive has done `CachePerfPrms.LRUEvictions`, based on checking lruEvictions stat, and at least `CachePerfPrms.LRUEvictionsMinWaitSec` has passed.
`static boolean`	`terminateOnMaxKey(CachePerfClient c)` Returns true when a client has done `CachePerfPrms.maxKeys` of the operation.
`static boolean`	`terminateOnNumDestroys(CachePerfClient c)` Returns true when each stat archive has done `CachePerfPrms.numDestroys`, based on checking destroys stat, and at least `CachePerfPrms.numDestroysMinWaitSec` has passed.
`static boolean`	`terminateOnNumOperations(CachePerfClient c)` Returns true when a client has done `CachePerfPrms.numOperations` operations.
`static boolean`	`terminateOnSignal(CachePerfClient c)` Returns true when the shared counter in `TaskSyncBlackboard.signal` is non-zero.
`static boolean`	`terminateOnTotalIterations(CachePerfClient c)` Returns true when a client has done `CachePerfPrms.trimIterations` plus `CachePerfPrms.workIterations` of the operation.
`static boolean`	`terminateOnTotalSeconds(CachePerfClient c)` Returns true when a client has done the operation for `CachePerfPrms.trimSeconds` plus `CachePerfPrms.workSeconds`.
`static boolean`	`terminateOnTrimIterations(CachePerfClient c)` Returns true when a client has done `CachePerfPrms.trimIterations` of the operation.
`static boolean`	`terminateOnTrimSeconds(CachePerfClient c)` Returns true when a client has done the operation for `CachePerfPrms.trimSeconds` seconds.
`static boolean`	`terminateOnWorkIterations(CachePerfClient c)` Returns true when a client has done `CachePerfPrms.workIterations` of the operation after warmup is completed.
`static boolean`	`terminateOnWorkSeconds(CachePerfClient c)` Returns true when a client has done the operation for `CachePerfPrms.workSeconds` seconds after warmup is completed.

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

- Constructor Detail
  - Terminators
```
public Terminators()
```
- Method Detail
  - terminateOnBatchSeconds
```
public static boolean terminateOnBatchSeconds(CachePerfClient c)
```
    Returns true when a client has done the operation for CachePerfPrms.batchSeconds seconds.
    
    Since:
    
    5.0
  - terminateOnBatchSize
```
public static boolean terminateOnBatchSize(CachePerfClient c)
```
    Returns true when a client has done CachePerfPrms.batchSize of the operation.
  - terminateOnTrimSeconds
```
public static boolean terminateOnTrimSeconds(CachePerfClient c)
```
    Returns true when a client has done the operation for CachePerfPrms.trimSeconds seconds.
    
    Since:
    
    5.0
  - terminateAndSignalOnTrimSeconds
```
public static boolean terminateAndSignalOnTrimSeconds(CachePerfClient c)
```
    Returns true when a client has done the operation for CachePerfPrms.trimSeconds seconds. Signals others using TaskSyncBlackboard.trimSignal.
    
    Since:
    
    5.0
  - terminateOnWorkSeconds
```
public static boolean terminateOnWorkSeconds(CachePerfClient c)
```
    Returns true when a client has done the operation for CachePerfPrms.workSeconds seconds after warmup is completed.
    
    Since:
    
    5.0
  - terminateOnTotalSeconds
```
public static boolean terminateOnTotalSeconds(CachePerfClient c)
```
    Returns true when a client has done the operation for CachePerfPrms.trimSeconds plus CachePerfPrms.workSeconds.
    
    Since:
    
    5.0
  - terminateOnTrimIterations
```
public static boolean terminateOnTrimIterations(CachePerfClient c)
```
    Returns true when a client has done CachePerfPrms.trimIterations of the operation.
  - terminateOnWorkIterations
```
public static boolean terminateOnWorkIterations(CachePerfClient c)
```
    Returns true when a client has done CachePerfPrms.workIterations of the operation after warmup is completed.
  - terminateOnTotalIterations
```
public static boolean terminateOnTotalIterations(CachePerfClient c)
```
    Returns true when a client has done CachePerfPrms.trimIterations plus CachePerfPrms.workIterations of the operation.
  - terminateOnMaxKey
```
public static boolean terminateOnMaxKey(CachePerfClient c)
```
    Returns true when a client has done CachePerfPrms.maxKeys of the operation.
  - terminateOnNumOperations
```
public static boolean terminateOnNumOperations(CachePerfClient c)
```
    Returns true when a client has done CachePerfPrms.numOperations operations.
  - terminateOnLRUEvictions
```
public static boolean terminateOnLRUEvictions(CachePerfClient c)
```
    Returns true when each stat archive has done CachePerfPrms.LRUEvictions, based on checking lruEvictions stat, and at least CachePerfPrms.LRUEvictionsMinWaitSec has passed.
    
    Throws:
    
    CachePerfException - if this does not occur within CachePerfPrms.LRUEvictionsMaxWaitSec.
  - terminateOnNumDestroys
```
public static boolean terminateOnNumDestroys(CachePerfClient c)
```
    Returns true when each stat archive has done CachePerfPrms.numDestroys, based on checking destroys stat, and at least CachePerfPrms.numDestroysMinWaitSec has passed.
    
    Throws:
    
    CachePerfException - if this does not occur within CachePerfPrms.numDestroysMaxWaitSec.
  - terminateOnSignal
```
public static boolean terminateOnSignal(CachePerfClient c)
```
    Returns true when the shared counter in TaskSyncBlackboard.signal is non-zero.
  - terminateOnGetInitialImageInProgress
```
public static boolean terminateOnGetInitialImageInProgress(CachePerfClient c)
```
    Returns true when the shared counter in getInitialImage.InitImageBB.getInitialImagesInProgress is non-zero.
  - terminateOnGetInitialImageComplete
```
public static boolean terminateOnGetInitialImageComplete(CachePerfClient c)
```
    Returns true when the shared counter in getInitialImage.InitImageBB.getInitialImagesCompleted is non-zero.

Class Terminators

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Terminators

Method Detail

terminateOnBatchSeconds

terminateOnBatchSize

terminateOnTrimSeconds

terminateAndSignalOnTrimSeconds

terminateOnWorkSeconds

terminateOnTotalSeconds

terminateOnTrimIterations

terminateOnWorkIterations

terminateOnTotalIterations

terminateOnMaxKey

terminateOnNumOperations

terminateOnLRUEvictions

terminateOnNumDestroys

terminateOnSignal

terminateOnGetInitialImageInProgress

terminateOnGetInitialImageComplete