/*
 * This file is part of LuckPerms, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) <luck@lucko.me>
 *  Copyright (c) contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package me.lucko.luckperms.common.plugin;

import java.util.concurrent.Executor;

/**
 * A scheduler for running tasks using the systems provided by the platform
 */
public interface SchedulerAdapter {

    /**
     * Gets an async executor instance
     *
     * @return an async executor instance
     */
    Executor async();

    /**
     * Gets a sync executor instance
     *
     * @return a sync executor instance
     */
    Executor sync();

    /**
     * Executes a runnable async
     *
     * @param runnable the runnable
     */
    void doAsync(Runnable runnable);

    /**
     * Executes a runnable sync
     *
     * @param runnable the runnable
     */
    void doSync(Runnable runnable);

    /**
     * Runs a runnable repeatedly until the plugin disables. Will wait for the interval before the first iteration of the task is ran.
     *  @param runnable the runnable
     * @param intervalTicks the interval in ticks.
     */
    SchedulerTask asyncRepeating(Runnable runnable, long intervalTicks);

    /**
     * Runs a runnable repeatedly until the plugin disables. Will wait for the interval before the first iteration of the task is ran.
     *  @param runnable the runnable
     * @param intervalTicks the interval in ticks.
     */
    SchedulerTask syncRepeating(Runnable runnable, long intervalTicks);

    /**
     * Runs a runnable with a delay
     *  @param runnable the runnable
     * @param delayTicks the delay in ticks
     */
    SchedulerTask asyncLater(Runnable runnable, long delayTicks);

    /**
     * Runs a runnable with a delay
     *  @param runnable the runnable
     * @param delayTicks the delay in ticks
     */
    SchedulerTask syncLater(Runnable runnable, long delayTicks);

    /**
     * Shuts down this executor instance
     */
    void shutdown();

}
