com.iih5.actor.IActor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smart-actor Show documentation
这是一个Actor模型组件
There is a newer version: 1.1
/*
 * Copyright 2016 xueyi ([email protected])
 *
 * The Smart-Actor Project licenses this file to you 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 com.iih5.actor;

import com.iih5.actor.scheduler.LoopScheduledTask;
import com.iih5.actor.scheduler.ScheduledTask;

import java.util.concurrent.Callable;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

/**
 * 任务提交者接口,同一个Submiter提交的所有任务，能确保在同一个线程中顺序执行
 * @author Chenlong
 * */
public interface IActor {
	/**
	 * @return 当前Actor状态
	 * */
	ActorState getActorState();
	/**
	 * 获取actor的执行Executor（线程）
	 * */
	IActorExecutor getExecutor();
	/**
	 * 设置actor执行Executor
	 * 用于切换工作场景时，切换执行线程，比如用户进入某个房间，则要设置为房间的执行线程，这样就消除多线程的问题)
	 * @param executor
	 */
	void setExecutor(IActorExecutor executor);
	/**
	 * 设置actor执行Executor
	 * 用于切换工作场景时，切换执行线程，比如用户进入某个房间，则要设置为房间的执行线程，这样就消除多线程的问题)
	 * @param executor
	 */
	void switchExecutor(IActorExecutor executor);

	/**
	 * 立即将任务提交到队列中
	 * @param task
	 * @return
     */
	Future execute(Runnable task);
	/**
	 * 延时将任务提交到队列中
	 * @param task 任务
	 * @param delay 延迟时间
	 * @param unit 时间单位
	 * @return future
	 * */
	Future scheduledTask(Runnable task, long delay, TimeUnit unit);

	/**
	 * @see java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit)
	 * @param task
	 * @param delay
	 * @param period
	 * @param unit
     * @return
     */
	Future scheduleAtFixedRateTask(Runnable task, long delay, long period, TimeUnit unit);

	/**
	 * @see java.util.concurrent.ScheduledExecutorService#scheduleWithFixedDelay(Runnable, long, long, TimeUnit)
	 * @param task
	 * @param delay
	 * @param period
	 * @param unit
     * @return
     */
	Future scheduleWithFixedDelayTask(Runnable task, long delay, long period, TimeUnit unit);
    /**
     * 立即将任务提交到队列中
	 * @param task 任务
	 * @return future
     * */
     Future execute(Callable task);

	/**
	 * 延时将任务提交到队列中
	 * @param task
	 * @param delay
	 * @param unit
     * @return
     */
    Future scheduledTask(Callable task, long delay, TimeUnit unit);

	/**
	 * 添加定时循环执行的任务
	 * @param task
	 * @return
     */
	public Future addLoopTask(LoopScheduledTask task);
	/**
	 * @param  task 添加延迟执行一次的任务
	 * @return  future
	 * */
	public Future addTask(ScheduledTask task);
	/**
	 * 取消指定名称的任务
	 * @param name 任务唯一标示名 @see com.jcwx.frm.current.scheduled.ScheduledTask#getName()
	 * @param mayInterruptIfRunning 是否允许任务线程正在执行时中断
	 * @return true 成功取消 false 取消失败或者已经被执行
	 * */
	public boolean cancelTask(String name, boolean mayInterruptIfRunning);

	/**
	 * actor unique ID
	 * @return
     */
	public long getId();

}