hydra

Class GatewayReceiverPrms

java.lang.Object

hydra.BasePrms

hydra.GatewayReceiverPrms

public class GatewayReceiverPrms
extends BasePrms

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

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	endPort (int(s)) Ending port to use for each gateway receiver port range.
static Long	gatewayTransportFilters (Comma-separated String(s)) Class names of gateway transport filters for each gateway receiver.
static Long	maximumTimeBetweenPings (int(s)) Maximum time between pings for each gateway receiver.
static Long	names (String(s)) Logical names of the gateway receiver descriptions.
static Long	numInstances (int(s)) Number of ports to listen on per JVM for each gateway receiver when creating instances with #createAndStartGatewayReceiver(String).
static Long	socketBufferSize (int(s)) Socket buffer size for each gateway receiver.
static Long	startPort (int(s)) Starting port to use for each gateway receiver port range.

Fields inherited from class hydra.BasePrms

DASH, DEFAULT, NONE

Constructor Summary

Constructors

Constructor and Description
GatewayReceiverPrms()

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 receiver descriptions. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.

endPort

public static Long endPort

(int(s)) Ending port to use for each gateway receiver port range.

gatewayTransportFilters

public static Long gatewayTransportFilters

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

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

maximumTimeBetweenPings

public static Long maximumTimeBetweenPings

(int(s)) Maximum time between pings for each gateway receiver.

numInstances

public static Long numInstances

(int(s)) Number of ports to listen on per JVM for each gateway receiver when creating instances with #createAndStartGatewayReceiver(String). Defaults to 1.

For example,

startPort

public static Long startPort

(int(s)) Starting port to use for each gateway receiver port range.

socketBufferSize

public static Long socketBufferSize

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

Constructor Detail

GatewayReceiverPrms

public GatewayReceiverPrms()