com.spikhalskiy.hashedwheeltimer.Task Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hashed-wheel-timer Show documentation

Simple Hashed Wheel Timer implementation

The newest version!

/*
 * Copyright 2016 Dmitry Spikhalskiy. All Rights Reserved.
 *
 * 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 com.spikhalskiy.hashedwheeltimer;

/**
 * Functional interface to represent a work that should be executed by {@link HashedWheelTimer} on timeout.
 */
public interface Task {
    /**
     * @param timer {@link Timer} instance caused triggering of this method. Could assume that this timer is in
     * {@link Timer.TimerState#EXPIRED} state if this call triggered by {@link HashedWheelTimer}. Could be used for
     * rescheduling for example.
     */
    void run(Timer timer);
}