ai.grakn.engine.backgroundtasks

Interface BackgroundTask

All Known Implementing Classes:

PostProcessingTask

public interface BackgroundTask

Interface which all tasks that wish to be scheduled for later execution as background tasks must implement.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	pause() Called to suspend the execution of a currently running task.
void	restart() Called to restart a task regardless of where it is in its execution.
void	resume(Map<String,Object> m) Called to restore state necessary for execution to a previously suspended point by pause() however resume() itself should not aim to resume execution as this will be accomplished by a subsequent call to start().
void	start() Called to start execution of the task, may be called on a newly scheduled or previously stopped task.,
void	stop() Called to stop execution of the task, may be called on a running or paused task.

Method Detail

start

void start()

Called to start execution of the task, may be called on a newly scheduled or previously stopped task.,

stop

void stop()

Called to stop execution of the task, may be called on a running or paused task. Task should stop execution immediately and may be killed after this method exits.

pause

Map<String,Object> pause()

Called to suspend the execution of a currently running task. The object may be destroyed after this call.

Returns:

Map<> that will be passed to resume() to resume the task.

resume

void resume(Map<String,Object> m)

Called to restore state necessary for execution to a previously suspended point by pause() however resume() itself should not aim to resume execution as this will be accomplished by a subsequent call to start().

Parameters:

m - Map<> as returned by pause()

restart

void restart()

Called to restart a task regardless of where it is in its execution. The task should clean up any internal state and perform any actions necessary in order to successfully complete its execution as if it was starting from a clean state.