org.tio.utils.timer.TimerTaskEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mica-net-utils Show documentation
Mica net is a net framework.
There is a newer version: 1.0.8
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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 org.tio.utils.timer;


import java.util.Objects;

/**
 * 封装定时任务
 *
 * @author kafka、guest、L.cm
 */
public class TimerTaskEntry implements Comparable {
	private volatile TimerTaskList list;

	protected TimerTaskEntry next;

	protected TimerTaskEntry prev;

	private final TimerTask timerTask;

	private final long expirationMs;

	/**
	 * 构造器
	 *
	 * @param timerTask    定时任务
	 * @param expirationMs 到期时间
	 */
	public TimerTaskEntry(TimerTask timerTask, long expirationMs) {
		if (timerTask != null) {
			timerTask.setTimerTaskEntry(this);
		}
		this.timerTask = timerTask;
		this.expirationMs = expirationMs;
	}

	public boolean cancelled() {
		return timerTask.getTimerTaskEntry() != this;
	}

	public void remove() {
		TimerTaskList currentList = list;
		// If remove is called when another thread is moving the entry from a task entry list to another,
		// this may fail to remove the entry due to the change of value of list. Thus, we retry until the list becomes null.
		// In a rare case, this thread sees null and exits the loop, but the other thread insert the entry to another list later.
		while (currentList != null) {
			currentList.remove(this);
			currentList = list;
		}
	}

	@Override
	public int compareTo(TimerTaskEntry that) {
		long thatExpirationMs = Objects.requireNonNull(that, "Args that TimerTaskEntry is null").expirationMs;
		return Long.compare(this.expirationMs, thatExpirationMs);
	}

	public long getExpirationMs() {
		return expirationMs;
	}

	public TimerTask getTimerTask() {
		return timerTask;
	}

	public TimerTaskList getList() {
		return list;
	}

	public void setList(TimerTaskList list) {
		this.list = list;
	}

}