BridgePrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.BridgePrms

```
public class BridgePrms
extends BasePrms
```
A class used to store keys for bridge configuration settings. The settings are used to create instances of BridgeDescription.
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 and fields of a parameter can be set to BasePrms.DEFAULT, except where noted. This uses the product default, except where noted.
Values, fields, and subfields can be set to BasePrms.NONE where noted, with the documented effect.
Values and fields 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`	`capacity` (int(s)) Capacity of client queues for each bridge, in entries or megabytes, depending on the `evictionPolicy`.
`static Long`	`diskStoreName` (String(s)) Name of logical disk store configuration (and actual disk store name) to use on the client queues for each bridge, as found in `DiskStorePrms.names`.
`static Long`	`evictionPolicy` (String(s)) Eviction algorithm to use on the client queues for each bridge.
`static Long`	`groups` (Comma-separated String(s)) Server groups for each bridge.
`static Long`	`loadPollInterval` How frequently, in milliseconds, to poll the load probe.
`static Long`	`loadProbe` The fully qualified name of a class to use as the load probe for this bridge server.
`static Long`	`maxConnections` (int(s)) Max connections for each bridge.
`static Long`	`maximumMessageCount` (int(s)) Maximum message count for each bridge.
`static Long`	`maximumTimeBetweenPings` (int(s)) Maximum time between pings for each bridge.
`static Long`	`maxThreads` (int(s)) Max threads for each bridge (creates pool for NIO selector when non-zero).
`static Long`	`messageTimeToLive` (int(s)) Message time to live for each bridge, in seconds.
`static Long`	`names` (String(s)) Logical names of the bridge descriptions.
`static Long`	`socketBufferSize` (int(s)) Socket buffer size for each bridge.

Fields inherited from class hydra.BasePrms
DASH, DEFAULT, NONE

Constructor Summary

Constructors
Constructor and Description

BridgePrms()

Constructors
Constructor and Description
`BridgePrms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static void main(String[] args)
- 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

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(String[] args)`

- Field Detail
  - names
```
public static Long names
```
    (String(s)) Logical names of the bridge descriptions. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.
  - capacity
```
public static Long capacity
```
    (int(s)) Capacity of client queues for each bridge, in entries or megabytes, depending on the evictionPolicy.
  - diskStoreName
```
public static Long diskStoreName
```
    (String(s)) Name of logical disk store configuration (and actual disk store name) to use on the client queues for each bridge, as found in DiskStorePrms.names. Required when the evictionPolicy is set to cause eviction. Can be specified as BasePrms.NONE (default).
  - evictionPolicy
```
public static Long evictionPolicy
```
    (String(s)) Eviction algorithm to use on the client queues for each bridge. Can be specified as ${NONE} (no eviction). Valid policies are "mem" and "entry".
    If the algorithm causes eviction, diskStoreName must also be set. See also capacity.
  - groups
```
public static Long groups
```
    (Comma-separated String(s)) Server groups for each bridge.
  - loadPollInterval
```
public static Long loadPollInterval
```
    How frequently, in milliseconds, to poll the load probe.
  - loadProbe
```
public static Long loadProbe
```
    The fully qualified name of a class to use as the load probe for this bridge server. The class must have a no-args constructor.
  - maxConnections
```
public static Long maxConnections
```
    (int(s)) Max connections for each bridge.
  - maxThreads
```
public static Long maxThreads
```
    (int(s)) Max threads for each bridge (creates pool for NIO selector when non-zero).
  - maximumMessageCount
```
public static Long maximumMessageCount
```
    (int(s)) Maximum message count for each bridge.
  - maximumTimeBetweenPings
```
public static Long maximumTimeBetweenPings
```
    (int(s)) Maximum time between pings for each bridge.
  - messageTimeToLive
```
public static Long messageTimeToLive
```
    (int(s)) Message time to live for each bridge, in seconds.
  - socketBufferSize
```
public static Long socketBufferSize
```
    (int(s)) Socket buffer size for each bridge.
- Constructor Detail
  - BridgePrms
```
public BridgePrms()
```
- Method Detail
  - main
```
public static void main(String[] args)
```

Class BridgePrms

Field Summary

Fields inherited from class hydra.BasePrms

Constructor Summary

Method Summary

Methods inherited from class hydra.BasePrms

Methods inherited from class java.lang.Object

Field Detail

names

capacity

diskStoreName

evictionPolicy

groups

loadPollInterval

loadProbe

maxConnections

maxThreads

maximumMessageCount

maximumTimeBetweenPings

messageTimeToLive

socketBufferSize

Constructor Detail

BridgePrms

Method Detail

main