ai.grakn.engine.task.BackgroundTask Maven / Gradle / Ivy
/*
* Grakn - A Distributed Semantic Database
* Copyright (C) 2016-2018 Grakn Labs Limited
*
* Grakn is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Grakn is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Grakn. If not, see .
*/
package ai.grakn.engine.task;
/**
*
* Defines the API which must be implemented in order to be able to run the task in the background
*
*
* @author Filipe Peliz Pinto Teixeira
*/
public interface BackgroundTask extends AutoCloseable{
/**
* @return The amount of seconds to wait between running this job.
*/
default int period(){
return 60;
}
/**
* The primary method to execute when the {@link BackgroundTask} starts executing
*/
void run();
/**
* Shutdown the task. This is useful if the task creates it's own processes
*/
void close();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy