com.iohao.game.widget.light.timer.task.TimerTaskRegion Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of light-timer-task Show documentation
There is a newer version: 21.15
/*
 * ioGame
 * Copyright (C) 2021 - present  渔民小镇 （[email protected]、[email protected]） . All Rights Reserved.
 * # iohao.com . 渔民小镇
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see .
 */
package com.iohao.game.widget.light.timer.task;

import org.cache2k.Cache;

import java.util.Objects;

/**
 * 定时任务域
 *  *     负责定时任务的： 存储 获取
 * 
 *
 * @author 渔民小镇
 * @date 2021-12-25
 */
public interface TimerTaskRegion {
    /**
     * 定时任务管理
     *
     * @return 定时任务管理
     */
    Cache getCache();

    /**
     * region name
     *
     * @return regionName
     */
    String name();

    /**
     * 通过 key 删除定时任务
     *
     * @param key key
     */
    default void removeTimerTask(String key) {
        this.getCache().remove(key);
    }

    /**
     * getTimerTask
     *
     * @param key key
     * @return TimerTask
     */
    default TimerTask getTimerTask(String key) {
        return this.getCache().get(key);
    }

    /**
     * put 定时任务
     *
     * @param cacheKey  cacheKey
     * @param timerTask 定时任务
     */
    default void put(String cacheKey, TimerTask timerTask) {
        this.getCache().put(cacheKey, timerTask);
    }

    /**
     * 暂停 定时任务域 下的所有 定时任务
     *      *     这个方法方这里不太好， 暂时放这吧
     * 
     *
     * @param timeMillis 时间
     */
    default void pauseTask(long timeMillis) {
        Cache cache = this.getCache();
        for (String key : cache.keys()) {
            TimerTask timerTask = cache.get(key);
            if (Objects.nonNull(timerTask)) {
                timerTask.pause(timeMillis);
            }
        }
    }
}