org.opendaylight.vtn.manager.internal.util

Class VTNTimer

java.lang.Object

java.util.Timer

org.opendaylight.vtn.manager.internal.util.VTNTimer

public final class VTNTimer
extends Timer

VTNTimer describes a thread to schedule timer tasks.

Constructor Summary

Constructors

Constructor and Description
VTNTimer(String name) Construct a new timer thread associated with the given name.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel all tasks previously scheduled, and terminate this timer thread.
boolean	checkedSchedule(TimerTask task, long delay) Schedule the given task to be executed after the given delay.
boolean	flush(long timeout, TimeUnit unit) Flush the task queue for this timer.
boolean	isAvailable() Determine whether this timer is available or not.
void	schedule(TimerTask task, Date time) Schedule the given task to be executed at the given time.
void	schedule(TimerTask task, Date firstTime, long period) Schedule the given task to be executed periodically.
void	schedule(TimerTask task, long delay) Schedule the given task to be executed after the given delay.
void	schedule(TimerTask task, long delay, long period) Schedule the given task to be executed periodically.
void	scheduleAtFixedRate(TimerTask task, Date firstTime, long period) Schedule the given task to be executed periodically at the fixed rate.
void	scheduleAtFixedRate(TimerTask task, long delay, long period) Schedule the given task to be executed periodically at the fixed rate.
boolean	shutdown() Shut down the timer.

Methods inherited from class java.util.Timer

purge

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNTimer

public VTNTimer(String name)

Construct a new timer thread associated with the given name.

Parameters:

name - THe name of the timer thread.

Method Detail

shutdown

public boolean shutdown()

Shut down the timer.

Tasks previously scheduled are not canceled, but no more timer task will be scheduled.

Returns:

true if the timer shutdown has been initiated. false if the timer is already down.

isAvailable

public boolean isAvailable()

Determine whether this timer is available or not.

Returns:

true only if this timer is available.

flush

public boolean flush(long timeout,
                     TimeUnit unit)
              throws VTNException

Flush the task queue for this timer.

This method can be used even if the timer shut down is already initiated by shutdown().

Parameters:

timeout - The timeout to wait for all tasks to complete.

unit - The time unit for timeout argument.

Returns:

true if all tasks previously scheduled completed. false if this timer is already canceled.

Throws:

VTNException - An error occurred.

checkedSchedule

public boolean checkedSchedule(TimerTask task,
                               long delay)

Schedule the given task to be executed after the given delay.

Parameters:

task - A task to be executed.

delay - The number of milliseconds in delay before execution.

Returns:

true on success. false if this timer is unavailable.

schedule

public void schedule(TimerTask task,
                     long delay)

Schedule the given task to be executed after the given delay.

Overrides:

schedule in class Timer

Parameters:

task - A task to be executed.

delay - The number of milliseconds in delay before execution.

schedule

public void schedule(TimerTask task,
                     Date time)

Schedule the given task to be executed at the given time.

Overrides:

schedule in class Timer

Parameters:

task - A task to be executed.

time - A Date instance which specifies the time to execute the task.

schedule

public void schedule(TimerTask task,
                     long delay,
                     long period)

Schedule the given task to be executed periodically.

Overrides:

schedule in class Timer

Parameters:

task - A task to be executed.

delay - The number of milliseconds to be inserted before the first execution.

period - The number of milliseconds between successive task executions.

schedule

public void schedule(TimerTask task,
                     Date firstTime,
                     long period)

Schedule the given task to be executed periodically.

Overrides:

schedule in class Timer

Parameters:

task - A task to be executed.

firstTime - The time of the first execution.

period - The number of milliseconds between successive task executions.

scheduleAtFixedRate

public void scheduleAtFixedRate(TimerTask task,
                                long delay,
                                long period)

Schedule the given task to be executed periodically at the fixed rate.

Overrides:

scheduleAtFixedRate in class Timer

Parameters:

task - A task to be executed.

delay - The number of milliseconds to be inserted before the first execution.

period - The number of milliseconds between successive task executions.

scheduleAtFixedRate

public void scheduleAtFixedRate(TimerTask task,
                                Date firstTime,
                                long period)

Schedule the given task to be executed periodically at the fixed rate.

Overrides:

scheduleAtFixedRate in class Timer

Parameters:

task - A task to be executed.

firstTime - The time of the first execution.

period - The number of milliseconds between successive task executions.

cancel

public void cancel()

Cancel all tasks previously scheduled, and terminate this timer thread.

Overrides:

cancel in class Timer