TimeoutIndicator

java.lang.Object
- org.apache.sshd.common.session.helpers.TimeoutIndicator

public class TimeoutIndicator
extends java.lang.Object

Used to convey information about an expired timeout

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TimeoutIndicator.TimeoutStatus
Timeout status.

Field Summary

Fields
Modifier and Type Field Description

private long expiredValue

static TimeoutIndicator NONE

private TimeoutIndicator.TimeoutStatus status

private long thresholdValue

Constructor Summary

Constructors
Constructor Description

TimeoutIndicator(TimeoutIndicator.TimeoutStatus status, long thresholdValue, long expiredValue)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`long`	`getExpiredValue()`
`TimeoutIndicator.TimeoutStatus`	`getStatus()`
`long`	`getThresholdValue()`
`java.lang.String`	`toString()`

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

Field Detail

NONE

public static final TimeoutIndicator NONE

status

private final TimeoutIndicator.TimeoutStatus status

thresholdValue
```
private final long thresholdValue
```

expiredValue
```
private final long expiredValue
```

Constructor Detail
- TimeoutIndicator
```
public TimeoutIndicator(TimeoutIndicator.TimeoutStatus status,
                        long thresholdValue,
                        long expiredValue)
```
  Parameters:
  
  status - The expired timeout type (if any)
  
  thresholdValue - The configured timeout value
  
  expiredValue - The actual value that cause the timeout

Method Detail

getStatus

public TimeoutIndicator.TimeoutStatus getStatus()

getThresholdValue
```
public long getThresholdValue()
```

getExpiredValue
```
public long getExpiredValue()
```

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object