com.linecorp.armeria.internal.common

Class DefaultTimeoutController

java.lang.Object

com.linecorp.armeria.internal.common.DefaultTimeoutController

All Implemented Interfaces:

TimeoutController

public class DefaultTimeoutController
extends Object
implements TimeoutController

Default TimeoutController implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultTimeoutController.TimeoutTask A timeout task that is invoked when the deadline exceeded.

Constructor Summary

Constructors

Constructor and Description
DefaultTimeoutController(DefaultTimeoutController.TimeoutTask timeoutTask, io.netty.channel.EventLoop eventLoop) Creates a new instance with the specified DefaultTimeoutController.TimeoutTask and EventLoop.
DefaultTimeoutController(io.netty.channel.EventLoop eventLoop) Creates a new instance with the specified EventLoop.

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.
void	setTimeoutTask(DefaultTimeoutController.TimeoutTask timeoutTask) Sets the DefaultTimeoutController.TimeoutTask that is invoked when the deadline exceeded.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTimeoutController

public DefaultTimeoutController(DefaultTimeoutController.TimeoutTask timeoutTask,
                                io.netty.channel.EventLoop eventLoop)

Creates a new instance with the specified DefaultTimeoutController.TimeoutTask and EventLoop.

DefaultTimeoutController

public DefaultTimeoutController(io.netty.channel.EventLoop eventLoop)

Creates a new instance with the specified EventLoop.

Method Detail

setTimeoutTask

public void setTimeoutTask(DefaultTimeoutController.TimeoutTask timeoutTask)

Sets the DefaultTimeoutController.TimeoutTask that is invoked when the deadline exceeded.

scheduleTimeout

public 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.

Note that the DefaultTimeoutController.TimeoutTask should be set via the setTimeoutTask(TimeoutTask) or the DefaultTimeoutController(TimeoutTask, EventLoop) before calling this method.

Specified by:

scheduleTimeout in interface TimeoutController

Parameters:

timeoutMillis - a positive time amount value in milliseconds.

Returns:

true if the timeout is scheduled. false if the timeout has been scheduled, the timeout has been triggered already or the DefaultTimeoutController.TimeoutTask.canSchedule() returned false.

extendTimeout

public boolean extendTimeout(long adjustmentMillis)

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

Note that the DefaultTimeoutController.TimeoutTask should be set via the setTimeoutTask(TimeoutTask) or the DefaultTimeoutController(TimeoutTask, EventLoop) before calling this method.

Specified by:

extendTimeout in interface TimeoutController

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 the DefaultTimeoutController.TimeoutTask.canSchedule() returned false.

resetTimeout

public boolean resetTimeout(long newTimeoutMillis)

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

Note that the DefaultTimeoutController.TimeoutTask should be set via the setTimeoutTask(TimeoutTask) or the DefaultTimeoutController(TimeoutTask, EventLoop) before calling this method.

Specified by:

resetTimeout in interface TimeoutController

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 the DefaultTimeoutController.TimeoutTask.canSchedule() returned false.

timeoutNow

public boolean timeoutNow()

Trigger the current timeout immediately.

Specified by:

timeoutNow in interface TimeoutController

Returns:

true if the current timeout is triggered successfully. false the timeout has been triggered already or the DefaultTimeoutController.TimeoutTask.canSchedule() returned false.

cancelTimeout

public boolean cancelTimeout()

Description copied from interface: TimeoutController

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

Specified by:

cancelTimeout in interface TimeoutController

Returns:

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

isTimedOut

public boolean isTimedOut()

Description copied from interface: TimeoutController

Returns whether the timeout has been triggered or not.

Specified by:

isTimedOut in interface TimeoutController

Returns:

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

startTimeNanos

public Long startTimeNanos()

Description copied from interface: TimeoutController

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

Specified by:

startTimeNanos in interface TimeoutController