SendTrafficLoadMetric (mod_cluster (parent) 2.0.1.Final API)

java.lang.Object
- org.jboss.modcluster.load.metric.impl.AbstractLoadMetric
- - org.jboss.modcluster.load.metric.impl.SendTrafficLoadMetric

All Implemented Interfaces:

LoadMetric, LoadMetricMBean
```
public class SendTrafficLoadMetric
extends AbstractLoadMetric
```
LoadMetric implementation that returns the outgoing bandwidth in KB.

Author:

Paul Ferraro

Field Summary
- Fields inherited from interface org.jboss.modcluster.load.metric.LoadMetric
  DEFAULT_CAPACITY, DEFAULT_WEIGHT

Constructor Summary

Constructors
Constructor Description

SendTrafficLoadMetric()

SendTrafficLoadMetric(DeterministicLoadState state)

Method Summary

All Methods Instance Methods Concrete 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 class org.jboss.modcluster.load.metric.impl.AbstractLoadMetric
getCapacity, getWeight, setCapacity, setWeight

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

- Constructor Detail
  - SendTrafficLoadMetric
```
public SendTrafficLoadMetric()
```
  - SendTrafficLoadMetric
```
public SendTrafficLoadMetric(DeterministicLoadState state)
```
- Method Detail
  - getLoad
```
public double getLoad(Engine engine)
               throws Exception
```
    Description copied from interface: LoadMetric
    
    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.