com.qualcomm.robotcore.util

Class ThreadPool.Singleton<T>

java.lang.Object

com.qualcomm.robotcore.util.ThreadPool.Singleton<T>

Enclosing class:

ThreadPool

public static class ThreadPool.Singleton<T>
extends java.lang.Object

Singletons are helpers that gatekeep execution of work on a service to a single runnable at a time. Submitting a runnable will return a SingletonResult, either from a newly started item or one that was previously running. That result can be waited upon for completion. Alternately, the Singleton itself can be waited upon to await the completion of the currently running item, if any.

See Also:

ThreadPool.SingletonResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
Singleton()

Method Summary

Modifier and Type	Method and Description
T	await()
T	await(long ms) Awaits the completion of the extant work item, if one exists
ThreadPool.SingletonResult<T>	getResult() Returns the result from the extant or previous work item, if any; otherwise, null.
void	reset()
void	setService(java.util.concurrent.ExecutorService service)
ThreadPool.SingletonResult<T>	submit(java.util.concurrent.Callable<T> callable)
ThreadPool.SingletonResult<T>	submit(int msAwaitDefault, java.util.concurrent.Callable<T> callable)
ThreadPool.SingletonResult<T>	submit(int msAwaitDefault, java.lang.Runnable runnable) Submits a runnable to the service of this singleton, but only if there's not some other runnable currently submitted thereto.
ThreadPool.SingletonResult<T>	submit(java.lang.Runnable runnable)

Methods inherited from class java.lang.Object

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

Field Detail

INFINITE_TIMEOUT

public static int INFINITE_TIMEOUT

Constructor Detail

Singleton

public Singleton()

Method Detail

setService

public void setService(java.util.concurrent.ExecutorService service)

reset

public void reset()

submit

public ThreadPool.SingletonResult<T> submit(int msAwaitDefault,
                                            java.lang.Runnable runnable)

Submits a runnable to the service of this singleton, but only if there's not some other runnable currently submitted thereto.

Parameters:

runnable - the code to run if something's not already running

Returns:

a result that can be waited upon for completion

See Also:

await(long), submit(int, Callable), ThreadPool.SingletonResult.await(long)

submit

public ThreadPool.SingletonResult<T> submit(java.lang.Runnable runnable)

submit

public ThreadPool.SingletonResult<T> submit(int msAwaitDefault,
                                            java.util.concurrent.Callable<T> callable)

submit

public ThreadPool.SingletonResult<T> submit(java.util.concurrent.Callable<T> callable)

getResult

public ThreadPool.SingletonResult<T> getResult()

Returns the result from the extant or previous work item, if any; otherwise, null.

Returns:

the result from the extant or previous work item, if any; otherwise, null.

await

public T await(long ms)
        throws java.lang.InterruptedException

Awaits the completion of the extant work item, if one exists

Throws:

java.lang.InterruptedException

See Also:

getResult()

await

public T await()
        throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException