cn.wjybxx.concurrent.TimeSharingTask Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2023-2024 wjybxx([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package cn.wjybxx.concurrent;

import cn.wjybxx.base.annotation.Beta;

import javax.annotation.Nullable;

/**
 * 可分时运行的任务 - 需要长时间运行才能得出结果的任务。
 * 1. 分时任务代表着所有需要自定义管理状态的任务。
 * 2. 该接口尚不稳定，避免用于非EventLoop架构。
 * 3. 用户可以通过ctx和外部通信
 *
 * @author wjybxx
 * date 2023/4/3
 */
@Beta
public interface TimeSharingTask {

    /**
     * 执行一次
     *
     * @param ctx       任务关联的上下文
     * @param firstStep 是否是首次调度
     * @return 如果返回null，表示任务还需要继续执行。
     */
    @Nullable
    ResultHolder step(IContext ctx, boolean firstStep) throws Exception;

}