Package software.amazon.awssdk.core.internal.http.timers

Class ApiCallTimeoutTracker

java.lang.Object

software.amazon.awssdk.core.internal.http.timers.ApiCallTimeoutTracker

All Implemented Interfaces:

TimeoutTracker

@SdkInternalApi
public final class ApiCallTimeoutTracker
extends Object
implements TimeoutTracker

Api Call Timeout Tracker to track the TimeoutTask and the ScheduledFuture.

Constructor Summary

Constructors

Constructor	Description
ApiCallTimeoutTracker(TimeoutTask timeout, ScheduledFuture<?> future)

Method Summary

Modifier and Type	Method	Description
void	abortable(Abortable abortable)	Sets the abortable task to be aborted by TimeoutTask
void	cancel()	cancel the ScheduledFuture
boolean	hasExecuted()
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiCallTimeoutTracker

public ApiCallTimeoutTracker(TimeoutTask timeout,
                             ScheduledFuture<?> future)

Method Detail

hasExecuted

public boolean hasExecuted()

Specified by:

hasExecuted in interface TimeoutTracker

Returns:

True if timeout task has been executed. False otherwise

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface TimeoutTracker

Returns:

True if the timer task has been scheduled. False if the timeout is disabled for this request

cancel

public void cancel()

Description copied from interface: TimeoutTracker

cancel the ScheduledFuture

Specified by:

cancel in interface TimeoutTracker

abortable

public void abortable(Abortable abortable)

Description copied from interface: TimeoutTracker

Sets the abortable task to be aborted by TimeoutTask

Specified by:

abortable in interface TimeoutTracker

Parameters:

abortable - the abortable task