hydra

Class GatewaySenderPrms

java.lang.Object

hydra.BasePrms

hydra.GatewaySenderPrms

public class GatewaySenderPrms
extends BasePrms

A class used to store keys for gateway sender configuration settings. The settings are used to create instances of GatewaySenderDescription.

The number of description instances is gated by names. For other parameters, if fewer values than names are given, the remaining instances will use the last value in the list. See $JTESTS/hydra/hydra.txt for more details.

Unused parameters default to null, except where noted. This uses the product default, except where noted.

Values of a parameter can be set to BasePrms.DEFAULT, except where noted. This uses the product default, except where noted.

Values and fields can be set to BasePrms.NONE where noted, with the documented effect.

Values of a parameter can use oneof, range, or robing except where noted, but each description created will use a fixed value chosen at test configuration time. Use as a task attribute is illegal.

Field Summary

Fields

Modifier and Type	Field and Description
static Long	alertThreshold (int(s)) Alert threshold for each gateway sender, in milliseconds.
static Long	batchConflationEnabled (boolean(s)) Batch conflation enabled for each gateway sender.
static Long	batchSize (int(s)) Batch size for each gateway sender.
static Long	batchTimeInterval (int(s)) Batch time interval for each gateway sender.
static Long	diskStoreName (String(s)) Name of logical disk store configuration (and actual disk store name) for each gateway sender, as found in DiskStorePrms.names.
static Long	diskSynchronous (boolean(s)) Disk synchronous for each gateway sender.
static Long	dispatcherThreads (int(s)) Dispatcher threads for each gateway sender.
static Long	gatewayEventFilters (Comma-separated String(s)) Class names of gateway event filters for each gateway sender.
static Long	gatewayTransportFilters (Comma-separated String(s)) Class names of gateway transport filters for each gateway sender.
static Long	manualStart (boolean(s)) Manual start for each gateway sender.
static Long	maximumQueueMemory (int(s)) Maximum queue memory for each gateway sender.
static Long	names (String(s)) Logical names of the gateway sender descriptions.
static Long	orderPolicy (String(s)) Order policy for each gateway sender.
static Long	parallel (boolean(s)) Whether to send in parallel for each gateway sender.
static Long	persistenceEnabled (boolean(s)) Persistence enabled for each gateway sender.
static Long	remoteDistributedSystemsAlgorithm (Comma-separated String pair(s)) Algorithm used to generate the list of remote distributed systems for each logical gateway sender description.
static Long	socketBufferSize (int(s)) Socket buffer size for each gateway sender.
static Long	socketReadTimeout (int(s)) Socket read timeout for each gateway sender.

Fields inherited from class hydra.BasePrms

DASH, DEFAULT, NONE

Constructor Summary

Constructors

Constructor and Description
GatewaySenderPrms()

Method Summary

Methods inherited from class hydra.BasePrms

dumpKeys, keyForName, nameForKey, setValues, tab, tasktab

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

names

public static Long names

(String(s)) Logical names of the gateway sender descriptions. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.

The names are used as prefixes for gateway sender ids generated by GatewaySenderHelper#createGatewaySender(String).

alertThreshold

public static Long alertThreshold

(int(s)) Alert threshold for each gateway sender, in milliseconds.

batchConflationEnabled

public static Long batchConflationEnabled

(boolean(s)) Batch conflation enabled for each gateway sender.

batchSize

public static Long batchSize

(int(s)) Batch size for each gateway sender.

batchTimeInterval

public static Long batchTimeInterval

(int(s)) Batch time interval for each gateway sender.

diskStoreName

public static Long diskStoreName

(String(s)) Name of logical disk store configuration (and actual disk store name) for each gateway sender, as found in DiskStorePrms.names. This is a required parameter.

diskSynchronous

public static Long diskSynchronous

(boolean(s)) Disk synchronous for each gateway sender.

dispatcherThreads

public static Long dispatcherThreads

(int(s)) Dispatcher threads for each gateway sender.

gatewayEventFilters

public static Long gatewayEventFilters

(Comma-separated String(s)) Class names of gateway event filters for each gateway sender. Can be specified as BasePrms.NONE (default).

Example: To use ClassA and ClassB for the first gateway sender, none for the second gateway sender, and ClassC for the third gateway sender, specify: ClassA ClassB, none, ClassC

gatewayTransportFilters

public static Long gatewayTransportFilters

(Comma-separated String(s)) Class names of gateway transport filters for each gateway sender. Can be specified as BasePrms.NONE (default).

Example: To use ClassA and ClassB for the first gateway sender, none for the second gateway sender, and ClassC for the third gateway sender, specify: ClassA ClassB, none, ClassC

manualStart

public static Long manualStart

(boolean(s)) Manual start for each gateway sender.

maximumQueueMemory

public static Long maximumQueueMemory

(int(s)) Maximum queue memory for each gateway sender.

orderPolicy

public static Long orderPolicy

(String(s)) Order policy for each gateway sender.

parallel

public static Long parallel

(boolean(s)) Whether to send in parallel for each gateway sender.

persistenceEnabled

public static Long persistenceEnabled

(boolean(s)) Persistence enabled for each gateway sender.

remoteDistributedSystemsAlgorithm

public static Long remoteDistributedSystemsAlgorithm

(Comma-separated String pair(s)) Algorithm used to generate the list of remote distributed systems for each logical gateway sender description.

An algorithm consists of a classname followed by a method name. It must be of type public static Set and take no arguments. The return value must be a list of distributed system names as specified in GemFirePrms.distributedSystemthat are remote to the caller.

The algorithm is used by (String) to create a gateway sender for each remote distributed system in the list.

Suitable test configuration functions to use with the WAN topology include files in $JTESTS/hydraconfig are:

 
   // for a ring-connected topology
   hydra.GatewaySenderHelper getRingDistributedSystems

   // for a hub-and-spoke-connected topology
   hydra.GatewaySenderHelper getHubAndSpokeDistributedSystems

   // for a fully-connected topology
   hydra.GatewaySenderHelper getRemoteDistributedSystems (default)
 

socketBufferSize

public static Long socketBufferSize

(int(s)) Socket buffer size for each gateway sender.

socketReadTimeout

public static Long socketReadTimeout

(int(s)) Socket read timeout for each gateway sender.

Constructor Detail

GatewaySenderPrms

public GatewaySenderPrms()