LoadMetric (mod_cluster (parent) 2.0.1.Final API)

All Superinterfaces:

LoadMetricMBean

All Known Implementing Classes:

AbstractLoadMetric, AbstractMBeanLoadMetric, ActiveSessionsLoadMetric, AverageSystemLoadMetric, BusyConnectorsLoadMetric, HeapMemoryUsageLoadMetric, MBeanAttributeLoadMetric, MBeanAttributeRatioLoadMetric, ReceiveTrafficLoadMetric, RequestCountLoadMetric, SendTrafficLoadMetric
```
public interface LoadMetric
extends LoadMetricMBean
```
Represents a specific load metric.

Author:

Paul Ferraro

Field Summary

Fields
Modifier and Type Field Description

static double DEFAULT_CAPACITY

static int DEFAULT_WEIGHT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`double`	`getLoad(Engine engine)`	Returns the current load of this metric as a percent of the metric's capacity.

Methods inherited from interface org.jboss.modcluster.load.metric.LoadMetricMBean
getCapacity, getWeight, setCapacity, setWeight

- Field Detail
  - DEFAULT_CAPACITY
```
static final double DEFAULT_CAPACITY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_WEIGHT
```
static final int DEFAULT_WEIGHT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLoad
```
double getLoad(Engine engine)
        throws Exception
```
    Returns the current load of this metric as a percent of the metric's capacity.
    
    Returns:
    
    raw load / capacity.
    
    Throws:
    
    NodeUnavailableException - if the node should be put into the error state.
    
    Exception - if the load could not be determined.