Package org.apache.sshd.common.session.helpers

Class TimeoutIndicator

java.lang.Object

org.apache.sshd.common.session.helpers.TimeoutIndicator

public class TimeoutIndicator
extends Object

Used to convey information about an expired timeout

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeoutIndicator.TimeoutStatus	Timeout status.

Field Summary

Fields

Modifier and Type	Field	Description
static TimeoutIndicator	NONE

Constructor Summary

Constructors

Constructor	Description
TimeoutIndicator(TimeoutIndicator.TimeoutStatus status, Duration thresholdValue, Duration expiredValue)

Method Summary

Modifier and Type	Method	Description
Duration	getExpiredValue()
TimeoutIndicator.TimeoutStatus	getStatus()
Duration	getThresholdValue()
static String	toDisplayDurationValue(Duration d)
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

Constructor Detail

TimeoutIndicator

public TimeoutIndicator(TimeoutIndicator.TimeoutStatus status,
                        Duration thresholdValue,
                        Duration 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 Duration getThresholdValue()

getExpiredValue

public Duration getExpiredValue()

toString

public String toString()

Overrides:

toString in class Object

toDisplayDurationValue

public static String toDisplayDurationValue(Duration d)