io.streamnative.pulsar.handlers.kop.utils.timer.Timer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pulsar-protocol-handler-kafka Show documentation

Kafka on Pulsar implemented using Pulsar Protocol Handler

There is a newer version: 4.0.0.4

Show newest version

/**
 * Copyright (c) 2019 - 2024 StreamNative, Inc.. 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 io.streamnative.pulsar.handlers.kop.utils.timer;

/**
 * The timer interface to execute delayed operations.
 */
public interface Timer {

    /**
     * Add a new task to this executor. It will be executed after the task's delay
     * (beginning from the time of submission)
     *
     * @param timerTask the task to add
     */
    void add(TimerTask timerTask);

    /**
     * Advance the internal clock, executing any tasks whose expiration has been
     * reached within the duration of the passed timeout.
     *
     * @param timeoutMs
     * @return whether or not any tasks were executed
     */
    boolean advanceClock(long timeoutMs);

    /**
     * Get the number of tasks pending execution.
     *
     * @return the number of tasks
     */
    int size();

    /**
     * Shutdown the timer service, leaving pending tasks unexecuted.
     */
    void shutdown();


}