org.opendaylight.vtn.manager.internal.util.concurrent

Class TimeoutCounter

java.lang.Object

org.opendaylight.vtn.manager.internal.util.concurrent.TimeoutCounter

public abstract class TimeoutCounter
extends Object

TimeoutCounter describes a timeout period to suspend thread execution. It uses the monotonic system clock, so it is never affected by the change of the realtime system clock.

Note that this class is not synchronized. An instance of this class must not be shared with multiple threads.

Constructor Summary

Constructors

Constructor and Description
TimeoutCounter()

Method Summary

Modifier and Type	Method and Description
abstract void	await(Object obj) Wait for the given object to be notified.
abstract long	getRemains() Return the number of nanoseconds to wait.
static TimeoutCounter	newInfiniteTimeout() Create a new timeout counter that waits for the notification with infinite timeout.
static TimeoutCounter	newTimeout(long timeout, TimeUnit unit) Create a new timeout counter that waits for the notificaition within the specified timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeoutCounter

public TimeoutCounter()

Method Detail

newInfiniteTimeout

public static final TimeoutCounter newInfiniteTimeout()

Create a new timeout counter that waits for the notification with infinite timeout.

Returns:

A TimeoutCounter instance that has an infinite timeout.

newTimeout

public static final TimeoutCounter newTimeout(long timeout,
                                              TimeUnit unit)

Create a new timeout counter that waits for the notificaition within the specified timeout.

Parameters:

timeout - The maximum time to wait. Zero or a negative value is treated as an infinite timeout.

unit - The time unit of the timeout argument.

Returns:

A TimeoutCounter instance.

Throws:

NullPointerException - unit is null.

await

public abstract void await(Object obj)
                    throws InterruptedException,
                           TimeoutException

Wait for the given object to be notified.

Parameters:

obj - An object to wait on. Note that the caller hold the monitor of the specified object.

Throws:

InterruptedException - The calling thread was interrupted.

TimeoutException - The wait has been timed out.

NullPointerException - obj is null.

getRemains

public abstract long getRemains()
                         throws TimeoutException

Return the number of nanoseconds to wait.

Returns:

The number of nanoseconds to wait. Note that zero is returned if this counter representse an infinite timeout.

Throws:

TimeoutException - The wait has been timed out.