com.linecorp.armeria.internal.common

Interface TimeoutController

All Known Implementing Classes:

DefaultTimeoutController

public interface TimeoutController

A controller that schedules the timeout task with the initial value or reschedule when the timeout setting is changed.

Note: This interface is meant for internal use only.

Method Summary

Modifier and Type	Method and Description
boolean	cancelTimeout() Cancels the current timeout scheduled.
boolean	extendTimeout(long adjustmentMillis) Extends the current timeout by the specified adjustmentMillis.
boolean	isTimedOut() Returns whether the timeout has been triggered or not.
boolean	resetTimeout(long newTimeoutMillis) Sets the amount of time that is after the specified newTimeoutMillis from now.
boolean	scheduleTimeout(long timeoutMillis) Schedules a new timeout with the specified timeoutMillis.
Long	startTimeNanos() Returns the start time of the initial timeout in nanoseconds or null if no timeout was scheduled previously.
boolean	timeoutNow() Trigger the current timeout immediately.

Method Detail

scheduleTimeout

boolean scheduleTimeout(long timeoutMillis)

Schedules a new timeout with the specified timeoutMillis. If a timeout is scheduled already, this method will not start a new timeout.

Parameters:

timeoutMillis - a positive time amount value in milliseconds.

Returns:

true if the timeout is scheduled. false if the timeout has been scheduled, triggered already or a timeout cannot be scheduled, e.g. request or response has been handled already.

extendTimeout

boolean extendTimeout(long adjustmentMillis)

Extends the current timeout by the specified adjustmentMillis. Note that a negative adjustmentMillis reduces the current timeout.

Parameters:

adjustmentMillis - the adjustment of time amount value in milliseconds.

Returns:

true if the current timeout is extended by the specified adjustmentMillis. false if no timeout was scheduled previously, the timeout has been triggered already or a timeout cannot be scheduled, e.g. request or response has been handled already.

resetTimeout

boolean resetTimeout(long newTimeoutMillis)

Sets the amount of time that is after the specified newTimeoutMillis from now.

Parameters:

newTimeoutMillis - the new timeout value in milliseconds. 0 if disabled.

Returns:

true if the current timeout is reset by the specified newTimeoutMillis. false if the timeout has been triggered already or a timeout cannot be scheduled, e.g. request or response has been handled already.

timeoutNow

boolean timeoutNow()

Trigger the current timeout immediately.

Returns:

true if the current timeout is triggered successfully. false if the timeout has been triggered already or a timeout cannot be scheduled, e.g. request or response has been handled already.

cancelTimeout

boolean cancelTimeout()

Cancels the current timeout scheduled. You can schedule a new timeout with scheduleTimeout(long) if the current timeout is cancelled successfully.

Returns:

true if the current timeout is cancelled. false if the timeout has been triggered already or no timeout was scheduled previously.

isTimedOut

boolean isTimedOut()

Returns whether the timeout has been triggered or not.

Returns:

true if the timeout has been triggered already. false if the timeout is scheduled now or no timeout was scheduled previously.

startTimeNanos

Long startTimeNanos()

Returns the start time of the initial timeout in nanoseconds or null if no timeout was scheduled previously.