UseCase3Client (GemFire XD Java API Documentation)

java.lang.Object
- cacheperf.poc.useCase3_2.UseCase3Client

```
public class UseCase3Client
extends java.lang.Object
```
Client used to model a specific UseCase3 use case from July 2010.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allowNulls`
`int`	`batchSeconds`
`long`	`batchStartTime`
`java.lang.reflect.Method`	`batchTerminator`
`int`	`count`
`int`	`currentKey`
`java.util.List`	`interestListBatch`
`int`	`keyAllocation`
`int`	`keyAllocationChunkSize`
`int`	`keyCount`
`java.lang.String`	`keyType`
`long`	`lastTaskTerminatorTime`
`int`	`maxKeys`
`int`	`numThreads`
`java.util.Map<UseCase3Prms.RegionName,java.lang.Integer>`	`regionSpec`
`GsRandom`	`rng`
`long`	`startTime`
`UseCase3Stats`	`statistics`
`TestTask`	`task`
`java.lang.reflect.Method`	`taskTerminator`
`java.lang.Object[]`	`terminatorArgs`
`int`	`tgid`
`int`	`tid`
`int`	`ttgid`
`long`	`workloadStartTime`

Constructor Summary

Constructors
Constructor and Description

UseCase3Client()

Constructors
Constructor and Description
`UseCase3Client()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`all(java.lang.String prefix, int n, java.lang.String regionConfigs)` Returns a string that maps each key (prefix1...prefixN) to all of the region configs, with a comma separating each key-values pair.
`static void`	`bounceTask()` TASK to bounce a server.
`static void`	`closeCacheTask()` INITTASK to close the cache.
`protected void`	`closeStatistics()`
`static void`	`closeStatisticsTask()` INITTASK to unregister the cache performance and clock skew statistics objects.
`static void`	`connectTask()` INITTASK to connect to the distributed system.
`static void`	`createAndStartAgentTask()` INITTASK to create and start an agent and connect it to an admin distributed system.
`static void`	`createAndStartLocatorTask()` INITTASK to create and start a locator and connect it to an admin distributed system.
`static void`	`createCacheTask()` INITTASK to create the cache.
`static void`	`createDataTask()` INITTASK to create objects of type `cacheperf.UseCase3Prms#objectType`.
`static void`	`createPoolTask()` INITTASK to create a pool.
`static void`	`createRegionsTask()` INITTASK to create the regions.
`static void`	`disconnectTask()` INITTASK to disconnect from the distributed system.
`protected boolean`	`executeBatchTerminator()`
`protected void`	`executeTaskTerminator()`
`protected java.lang.Object`	`executeTerminator(java.lang.reflect.Method m)`
`protected int`	`getCount()` Gets the count for a thread's workload.
`protected int`	`getCurrentKey()` Gets the current key for a thread's workload.
`protected int`	`getKeyCount()` Gets the key count for a thread's workload.
`protected java.lang.String`	`getKeyType()` Gets the key type for a thread's workload.
`protected long`	`getLastTaskTerminatorTime()` Gets the last task terminator time for a thread's workload.
`protected java.lang.reflect.Method`	`getMethod(java.lang.String className, java.lang.String methodName)`
`protected int`	`getNextKey()`
`protected GsRandom`	`getRNG()` Gets the random number generator.
`protected long`	`getStartTime()` Gets the start time for a thread's workload.
`protected UseCase3Stats`	`getStatistics()` Gets the per-thread performance statistics instance.
`protected TestTask`	`getTask()` Gets the current task.
`static java.util.List<java.lang.String>`	`getTokens(java.lang.String str)`
`protected long`	`getWorkloadStartTime()` Gets the workload start time for a thread's workload.
`protected void`	`initBatchVariables()`
`protected void`	`initHydraThreadLocals()`
`protected void`	`initialize()`
`protected void`	`initLocalParameters()`
`protected void`	`initLocalVariables()`
`static void`	`mixDataTask()` TASK to mix objects.
`protected static int`	`numThreads()` Gets the total number of threads eligible to run the current task.
`protected static int`	`numThreadsInVM()` Gets the number of hydra threads in this vm.
`static void`	`openStatisticsTask()` INITTASK to register the cache performance and clock skew statistics objects.
`static void`	`putDataTask()` TASK to put objects.
`static void`	`rebalanceTask()`
`static void`	`registerInterestRegexAllTask()` INITTASK to register interest in all keys using a regular expression.
`static void`	`registerInterestTask()` INITTASK to register interest.
`protected void`	`resetHydraThreadLocals()`
`protected void`	`setCount(int n)` Sets the count for a thread's workload.
`protected void`	`setCurrentKey(int n)` Sets the current key for a thread's workload.
`protected void`	`setKeyCount(int n)` Sets the key count for a thread's workload.
`protected void`	`setKeyType(java.lang.String t)` Sets the key type for a thread's workload.
`protected void`	`setLastTaskTerminatorTime(long t)` Sets the last task terminator time for a thread's workload.
`protected void`	`setStartTime(long t)` Sets the start time for a thread's workload.
`protected void`	`setStatistics(UseCase3Stats stats)` Sets the per-thread performance statistics instance.
`protected void`	`setWorkloadStartTime(long t)` Sets the workload start time for a thread's workload.
`static void`	`startServerTask()` INITTASK to start the server.
`static java.lang.String`	`subset(java.lang.String prefix, int n, int subsetSize1, java.lang.String regionConfigs1, int subsetSize2, java.lang.String regionConfigs2)` Returns a string that maps each key (prefix1...prefixN) to the union of subsets of each group of region configs, with a comma separating each key-values pair.
`protected int`	`tgid()` Gets the client's hydra threadgroup id.
`protected int`	`tid()` Gets the client's hydra thread id.
`protected int`	`ttgid()` Gets the client's hydra threadgroup id for the current task.
`protected void`	`updateHydraThreadLocals()`

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

- Field Detail
  - tid
```
public int tid
```
  - tgid
```
public int tgid
```
  - ttgid
```
public int ttgid
```
  - numThreads
```
public int numThreads
```
  - interestListBatch
```
public java.util.List interestListBatch
```
  - batchStartTime
```
public long batchStartTime
```
  - allowNulls
```
public boolean allowNulls
```
  - regionSpec
```
public java.util.Map<UseCase3Prms.RegionName,java.lang.Integer> regionSpec
```
  - batchSeconds
```
public int batchSeconds
```
  - keyAllocation
```
public int keyAllocation
```
  - keyAllocationChunkSize
```
public int keyAllocationChunkSize
```
  - maxKeys
```
public int maxKeys
```
  - batchTerminator
```
public java.lang.reflect.Method batchTerminator
```
  - taskTerminator
```
public java.lang.reflect.Method taskTerminator
```
  - terminatorArgs
```
public java.lang.Object[] terminatorArgs
```
  - task
```
public TestTask task
```
  - statistics
```
public UseCase3Stats statistics
```
  - rng
```
public GsRandom rng
```
  - count
```
public int count
```
  - startTime
```
public long startTime
```
  - keyCount
```
public int keyCount
```
  - currentKey
```
public int currentKey
```
  - keyType
```
public java.lang.String keyType
```
  - lastTaskTerminatorTime
```
public long lastTaskTerminatorTime
```
  - workloadStartTime
```
public long workloadStartTime
```
- Constructor Detail
  - UseCase3Client
```
public UseCase3Client()
```
- Method Detail
  - createAndStartLocatorTask
```
public static void createAndStartLocatorTask()
```
    INITTASK to create and start a locator and connect it to an admin distributed system.
  - createAndStartAgentTask
```
public static void createAndStartAgentTask()
```
    INITTASK to create and start an agent and connect it to an admin distributed system.
  - connectTask
```
public static void connectTask()
```
    INITTASK to connect to the distributed system.
  - disconnectTask
```
public static void disconnectTask()
```
    INITTASK to disconnect from the distributed system.
  - openStatisticsTask
```
public static void openStatisticsTask()
```
    INITTASK to register the cache performance and clock skew statistics objects.
  - closeStatisticsTask
```
public static void closeStatisticsTask()
```
    INITTASK to unregister the cache performance and clock skew statistics objects.
  - closeStatistics
```
protected void closeStatistics()
```
  - createCacheTask
```
public static void createCacheTask()
```
    INITTASK to create the cache.
  - closeCacheTask
```
public static void closeCacheTask()
```
    INITTASK to close the cache.
  - createRegionsTask
```
public static void createRegionsTask()
```
    INITTASK to create the regions.
  - startServerTask
```
public static void startServerTask()
```
    INITTASK to start the server.
  - createPoolTask
```
public static void createPoolTask()
```
    INITTASK to create a pool.
  - registerInterestTask
```
public static void registerInterestTask()
```
    INITTASK to register interest. Registers interest in #interestTotalKeys in batches of size UseCase3Prms.interestBatchSize. A single thread does all of the registrations.
  - registerInterestRegexAllTask
```
public static void registerInterestRegexAllTask()
```
    INITTASK to register interest in all keys using a regular expression.
  - createDataTask
```
public static void createDataTask()
```
    INITTASK to create objects of type cacheperf.UseCase3Prms#objectType. Each client puts a new object at a new key.
  - putDataTask
```
public static void putDataTask()
```
    TASK to put objects.
  - mixDataTask
```
public static void mixDataTask()
```
    TASK to mix objects.
  - bounceTask
```
public static void bounceTask()
                       throws ClientVmNotFoundException
```
    TASK to bounce a server. Selects a VM of type "server". Sleeps UseCase3Prms.stopWaitSec. Synchronously stops the VM using a nice exit, or a mean kill if UseCase3Prms.useMeanKill is true. Restarts the VM after UseCase3Prms.restartWaitSec seconds.
    
    Throws:
    
    ClientVmNotFoundException
  - rebalanceTask
```
public static void rebalanceTask()
                          throws java.lang.InterruptedException
```
    Throws:
    
    java.lang.InterruptedException
  - getNextKey
```
protected int getNextKey()
```
  - executeBatchTerminator
```
protected boolean executeBatchTerminator()
```
  - executeTaskTerminator
```
protected void executeTaskTerminator()
```
  - getMethod
```
protected java.lang.reflect.Method getMethod(java.lang.String className,
                                             java.lang.String methodName)
```
  - executeTerminator
```
protected java.lang.Object executeTerminator(java.lang.reflect.Method m)
```
  - initialize
```
protected void initialize()
```
  - initLocalVariables
```
protected void initLocalVariables()
```
  - initBatchVariables
```
protected void initBatchVariables()
```
  - initLocalParameters
```
protected void initLocalParameters()
```
  - initHydraThreadLocals
```
protected void initHydraThreadLocals()
```
  - resetHydraThreadLocals
```
protected void resetHydraThreadLocals()
```
  - updateHydraThreadLocals
```
protected void updateHydraThreadLocals()
```
  - getTask
```
protected TestTask getTask()
```
    Gets the current task.
  - getStatistics
```
protected UseCase3Stats getStatistics()
```
    Gets the per-thread performance statistics instance.
  - setStatistics
```
protected void setStatistics(UseCase3Stats stats)
```
    Sets the per-thread performance statistics instance.
  - getCount
```
protected int getCount()
```
    Gets the count for a thread's workload.
  - setCount
```
protected void setCount(int n)
```
    Sets the count for a thread's workload.
  - getKeyCount
```
protected int getKeyCount()
```
    Gets the key count for a thread's workload.
  - setKeyCount
```
protected void setKeyCount(int n)
```
    Sets the key count for a thread's workload.
  - getCurrentKey
```
protected int getCurrentKey()
```
    Gets the current key for a thread's workload.
  - setCurrentKey
```
protected void setCurrentKey(int n)
```
    Sets the current key for a thread's workload.
  - getKeyType
```
protected java.lang.String getKeyType()
```
    Gets the key type for a thread's workload.
  - setKeyType
```
protected void setKeyType(java.lang.String t)
```
    Sets the key type for a thread's workload.
  - getLastTaskTerminatorTime
```
protected long getLastTaskTerminatorTime()
```
    Gets the last task terminator time for a thread's workload.
  - setLastTaskTerminatorTime
```
protected void setLastTaskTerminatorTime(long t)
```
    Sets the last task terminator time for a thread's workload.
  - getStartTime
```
protected long getStartTime()
```
    Gets the start time for a thread's workload.
  - setStartTime
```
protected void setStartTime(long t)
```
    Sets the start time for a thread's workload.
  - getWorkloadStartTime
```
protected long getWorkloadStartTime()
```
    Gets the workload start time for a thread's workload.
  - setWorkloadStartTime
```
protected void setWorkloadStartTime(long t)
```
    Sets the workload start time for a thread's workload.
  - getRNG
```
protected GsRandom getRNG()
```
    Gets the random number generator.
  - subset
```
public static java.lang.String subset(java.lang.String prefix,
                                      int n,
                                      int subsetSize1,
                                      java.lang.String regionConfigs1,
                                      int subsetSize2,
                                      java.lang.String regionConfigs2)
```
    Returns a string that maps each key (prefix1...prefixN) to the union of subsets of each group of region configs, with a comma separating each key-values pair.
  - all
```
public static java.lang.String all(java.lang.String prefix,
                                   int n,
                                   java.lang.String regionConfigs)
```
    Returns a string that maps each key (prefix1...prefixN) to all of the region configs, with a comma separating each key-values pair.
  - getTokens
```
public static java.util.List<java.lang.String> getTokens(java.lang.String str)
```
  - tid
```
protected int tid()
```
    Gets the client's hydra thread id.
  - tgid
```
protected int tgid()
```
    Gets the client's hydra threadgroup id.
  - ttgid
```
protected int ttgid()
```
    Gets the client's hydra threadgroup id for the current task.
  - numThreadsInVM
```
protected static int numThreadsInVM()
```
    Gets the number of hydra threads in this vm.
  - numThreads
```
protected static int numThreads()
```
    Gets the total number of threads eligible to run the current task.

Class UseCase3Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tid

tgid

ttgid

numThreads

interestListBatch

batchStartTime

allowNulls

regionSpec

batchSeconds

keyAllocation

keyAllocationChunkSize

maxKeys

batchTerminator

taskTerminator

terminatorArgs

task

statistics

rng

count

startTime

keyCount

currentKey

keyType

lastTaskTerminatorTime

workloadStartTime

Constructor Detail

UseCase3Client

Method Detail

createAndStartLocatorTask

createAndStartAgentTask

connectTask

disconnectTask

openStatisticsTask

closeStatisticsTask

closeStatistics

createCacheTask

closeCacheTask

createRegionsTask

startServerTask

createPoolTask

registerInterestTask

registerInterestRegexAllTask

createDataTask

putDataTask

mixDataTask

bounceTask

rebalanceTask

getNextKey

executeBatchTerminator

executeTaskTerminator

getMethod

executeTerminator

initialize

initLocalVariables

initBatchVariables

initLocalParameters

initHydraThreadLocals

resetHydraThreadLocals

updateHydraThreadLocals

getTask

getStatistics

setStatistics

getCount

setCount

getKeyCount

setKeyCount

getCurrentKey

setCurrentKey

getKeyType

setKeyType

getLastTaskTerminatorTime

setLastTaskTerminatorTime

getStartTime

setStartTime