Host (smart-client 2.2.1 API)

java.lang.Object
- com.emc.rest.smart.Host

All Implemented Interfaces:

HostStats

Direct Known Subclasses:

VdcHost
```
public class Host
extends java.lang.Object
implements HostStats
```
Some basic statements about response index calculation:
- lower response index means the host is more likely to be used
- should be based primarily on number of open connections to the host
- an error will mark the host as unhealthy for errorWaitTime milliseconds
- multiple consecutive errors compound the unhealthy (cool down) period up to 16x the errorWaitTime

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`consecutiveErrors`
`static int`	`DEFAULT_ERROR_WAIT_MS`
`protected int`	`errorWaitTime`
`protected long`	`lastConnectionTime`
`protected long`	`lastLogTime`
`static int`	`LOG_DELAY`
`static int`	`MAX_COOL_DOWN_EXP`
`protected int`	`openConnections`
`protected long`	`totalConnections`
`protected long`	`totalErrors`

Constructor Summary

Constructors
Constructor and Description

Host(java.lang.String name)

Constructors
Constructor and Description
`Host(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`callComplete(boolean isError)`
`void`	`connectionClosed()`
`void`	`connectionOpened()`
`boolean`	`equals(java.lang.Object o)`
`long`	`getConsecutiveErrors()`
`int`	`getErrorWaitTime()`
`java.util.Date`	`getLastConnectionTime()`
`java.lang.String`	`getName()`
`int`	`getOpenConnections()`
`long`	`getResponseIndex()`
`long`	`getTotalConnections()`
`long`	`getTotalErrors()`
`int`	`hashCode()`
`boolean`	`isHealthy()`
`void`	`resetStats()` Resets historical metrics.
`void`	`setErrorWaitTime(int errorWaitTime)` Sets the number of milliseconds that should pass after an error has occurred before anyone should use this host.
`void`	`setHealthy(boolean healthy)`
`java.lang.String`	`toString()`
`Host`	`withErrorWaitTime(int errorWaitTime)`

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

- Field Detail
  - DEFAULT_ERROR_WAIT_MS
```
public static final int DEFAULT_ERROR_WAIT_MS
```
    See Also:
    
    Constant Field Values
  - LOG_DELAY
```
public static final int LOG_DELAY
```
    See Also:
    
    Constant Field Values
  - MAX_COOL_DOWN_EXP
```
public static final int MAX_COOL_DOWN_EXP
```
    See Also:
    
    Constant Field Values
  - errorWaitTime
```
protected int errorWaitTime
```
  - openConnections
```
protected int openConnections
```
  - lastConnectionTime
```
protected long lastConnectionTime
```
  - totalConnections
```
protected long totalConnections
```
  - totalErrors
```
protected long totalErrors
```
  - consecutiveErrors
```
protected long consecutiveErrors
```
  - lastLogTime
```
protected long lastLogTime
```
- Constructor Detail
  - Host
```
public Host(java.lang.String name)
```
    Parameters:
    
    name - the host name or IP address of this host
- Method Detail
  - connectionOpened
```
public void connectionOpened()
```
  - connectionClosed
```
public void connectionClosed()
```
  - callComplete
```
public void callComplete(boolean isError)
```
  - getName
```
public java.lang.String getName()
```
  - isHealthy
```
public boolean isHealthy()
```
  - setHealthy
```
public void setHealthy(boolean healthy)
```
  - getResponseIndex
```
public long getResponseIndex()
```
  - resetStats
```
public void resetStats()
```
    Resets historical metrics. Use with care!
  - getTotalConnections
```
public long getTotalConnections()
```
    Specified by:
    
    getTotalConnections in interface HostStats
  - getTotalErrors
```
public long getTotalErrors()
```
    Specified by:
    
    getTotalErrors in interface HostStats
  - getOpenConnections
```
public int getOpenConnections()
```
    Specified by:
    
    getOpenConnections in interface HostStats
  - getLastConnectionTime
```
public java.util.Date getLastConnectionTime()
```
    Specified by:
    
    getLastConnectionTime in interface HostStats
  - getConsecutiveErrors
```
public long getConsecutiveErrors()
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getErrorWaitTime
```
public int getErrorWaitTime()
```
  - setErrorWaitTime
```
public void setErrorWaitTime(int errorWaitTime)
```
    Sets the number of milliseconds that should pass after an error has occurred before anyone should use this host. This time is compounded exponentially (* 2 ^ n) for consecutive errors.
  - withErrorWaitTime
```
public Host withErrorWaitTime(int errorWaitTime)
```

Class Host

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ERROR_WAIT_MS

LOG_DELAY

MAX_COOL_DOWN_EXP

errorWaitTime

openConnections

lastConnectionTime

totalConnections

totalErrors

consecutiveErrors

lastLogTime

Constructor Detail

Host

Method Detail

connectionOpened

connectionClosed

callComplete

getName

isHealthy

setHealthy

getResponseIndex

resetStats

getTotalConnections

getTotalErrors

getOpenConnections

getLastConnectionTime

getConsecutiveErrors

equals

hashCode

toString

getErrorWaitTime

setErrorWaitTime

withErrorWaitTime