com.facebook.buck.support.bgtasks

Class BackgroundTaskManager

java.lang.Object

com.facebook.buck.support.bgtasks.BackgroundTaskManager

Direct Known Subclasses:

AsyncBackgroundTaskManager

public abstract class BackgroundTaskManager
extends Object

BackgroundTaskManager schedules and runs background tasks like cleanup and logging. A manager should be notified when a new command starts and when it finishes so that it can schedule tasks appropriately. Tasks should typically be scheduled through a TaskManagerCommandScope.

Constructor Summary

Constructors

Constructor and Description
BackgroundTaskManager()

Method Summary

Modifier and Type	Method and Description
abstract TaskManagerCommandScope	getNewScope(BuildId buildId, boolean blocking) Returns a new TaskManagerCommandScope for a build on this manager.
abstract void	shutdown(long timeout, TimeUnit units) Shut down manager, waiting until given timeout for tasks to finish.
abstract void	shutdownNow() Shut down manager, without waiting for tasks to finish.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundTaskManager

public BackgroundTaskManager()

Method Detail

getNewScope

public abstract TaskManagerCommandScope getNewScope(BuildId buildId,
                                                    boolean blocking)

Returns a new TaskManagerCommandScope for a build on this manager. The TaskManagerCommandScope lives for the duration of the command such that it's TaskManagerCommandScope.close() will trigger the tasks scheduled to be ran.

Parameters:

buildId - unique identifier BuildId of a command that created a scope

blocking - whether the current command should wait for tasks to finish on exit

shutdownNow

public abstract void shutdownNow()

Shut down manager, without waiting for tasks to finish.

shutdown

public abstract void shutdown(long timeout,
                              TimeUnit units)
                       throws InterruptedException

Shut down manager, waiting until given timeout for tasks to finish.

Parameters:

timeout - timeout for tasks to finish

units - units of timeout

Throws:

InterruptedException