Top Description Inners Fields Constructors Methods
org.apache.sshd.common.session.helpers

public Class TimeoutIndicator

extends Object
Class Inheritance
Imports
java.time.Duration
Used to convey information about an expired timeout
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
TimeoutIndicator.TimeoutStatus

Timeout status.

Field Summary

Modifier and TypeField and Description
private final Duration
expiredValue

public static final TimeoutIndicator
NONE

private final TimeoutIndicator.TimeoutStatus
status

private final Duration
thresholdValue

Constructor Summary

AccessConstructor and Description
public
TimeoutIndicator(TimeoutIndicator.TimeoutStatus
The expired timeout type (if any)
status, Duration
The configured timeout value
thresholdValue, Duration
The actual value that cause the timeout
expiredValue)

Method Summary

Modifier and TypeMethod and Description
public Duration
getExpiredValue()

public TimeoutIndicator.TimeoutStatus
getStatus()

public Duration
getThresholdValue()

public static String
toDisplayDurationValue(Duration d)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

expiredValueback to summary
private final Duration expiredValue
NONEback to summary
public static final TimeoutIndicator NONE
statusback to summary
private final TimeoutIndicator.TimeoutStatus status
thresholdValueback to summary
private final Duration thresholdValue

Constructor Detail

TimeoutIndicatorback to summary
public TimeoutIndicator(TimeoutIndicator.TimeoutStatus status, Duration thresholdValue, Duration expiredValue)
Parameters
status:TimeoutIndicator.TimeoutStatus

The expired timeout type (if any)

thresholdValue:Duration

The configured timeout value

expiredValue:Duration

The actual value that cause the timeout

Method Detail

getExpiredValueback to summary
public Duration getExpiredValue()
getStatusback to summary
public TimeoutIndicator.TimeoutStatus getStatus()
getThresholdValueback to summary
public Duration getThresholdValue()
toDisplayDurationValueback to summary
public static String toDisplayDurationValue(Duration d)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.apache.sshd.common.session.helpers back to summary

public final Enum TimeoutIndicator.TimeoutStatus

extends Enum<TimeoutIndicator.TimeoutStatus>
Class Inheritance
Timeout status.

Field Summary

Modifier and TypeField and Description
public static final TimeoutIndicator.TimeoutStatus
AuthTimeout

public static final TimeoutIndicator.TimeoutStatus
IdleTimeout

public static final TimeoutIndicator.TimeoutStatus
NoTimeout

Constructor Summary

AccessConstructor and Description
private
TimeoutStatus()

Method Summary

Modifier and TypeMethod and Description
public static TimeoutIndicator.TimeoutStatus
valueOf(String name)

public static TimeoutIndicator.TimeoutStatus[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AuthTimeoutback to summary
public static final TimeoutIndicator.TimeoutStatus AuthTimeout
IdleTimeoutback to summary
public static final TimeoutIndicator.TimeoutStatus IdleTimeout
NoTimeoutback to summary
public static final TimeoutIndicator.TimeoutStatus NoTimeout

Constructor Detail

TimeoutStatusback to summary
private TimeoutStatus()

Method Detail

valueOfback to summary
public static TimeoutIndicator.TimeoutStatus valueOf(String name)
valuesback to summary
public static TimeoutIndicator.TimeoutStatus[] values()