com.pubmatic.sdk.common.utility

Class POBTimeoutHandler

java.lang.Object

com.pubmatic.sdk.common.utility.POBTimeoutHandler

public class POBTimeoutHandler
extends java.lang.Object

Class to handle custom implementation Timeout. To start the delay you can use start(long) to cancel existing delay you can use cancel()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	POBTimeoutHandler.POBTimeoutHandlerListener Interface definition to notify the time interval completes the delay and timeout is about to happen.

Constructor Summary

Constructors

Constructor and Description
POBTimeoutHandler(POBTimeoutHandler.POBTimeoutHandlerListener listener) Initialises Timer Handler with listener reference

Method Summary

Modifier and Type	Method and Description
void	cancel() Reset already running timer.
boolean	start(long delayInMs) Schedules the specified task for execution after the specified delay.
boolean	startAtFixedRate(long delayInMS, long period) Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBTimeoutHandler

public POBTimeoutHandler(@NonNull
                         POBTimeoutHandler.POBTimeoutHandlerListener listener)

Initialises Timer Handler with listener reference

Parameters:

listener - valid reference of listener

Method Detail

start

public boolean start(long delayInMs)

Schedules the specified task for execution after the specified delay. Note: If the task is already running, calling this method will cancels the existing task and schedules new task If delay is negative, timer won't start.

Parameters:

delayInMs - the delay time in millisecond.

Returns:

true if timeout starts successfully, else returns false

startAtFixedRate

public boolean startAtFixedRate(long delayInMS,
                                long period)

Schedules the specified task for repeated fixed-rate execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals, separated by the specified period. Note: If the task is already running, calling this method will cancels the existing task and schedules new task If delay is negative, timer won't start.

Parameters:

delayInMS - the delay time in millisecond.

period - regular interval time in millisecond

Returns:

true if timeout starts successfully, else returns false

cancel

public void cancel()

Reset already running timer. This will be the last state of the timer. You should create new object for further usage.