org.apache.flink.streaming.runtime.tasks.ProcessingTimeService Maven / Gradle / Ivy
/*
* 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.apache.flink.streaming.runtime.tasks;
import org.apache.flink.util.concurrent.ScheduledExecutor;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
/**
* Defines the current processing time and handles all related actions, such as register timers for
* tasks to be executed in the future.
*
* The access to the time via {@link #getCurrentProcessingTime()} is always available, regardless
* of whether the timer service has been shut down.
*/
public interface ProcessingTimeService
extends org.apache.flink.api.common.operators.ProcessingTimeService {
/**
* Registers a task to be executed repeatedly at a fixed rate.
*
*
This call behaves similar to {@link ScheduledExecutor#scheduleAtFixedRate(Runnable, long,
* long, TimeUnit)}.
*
* @param callback to be executed after the initial delay and then after each period
* @param initialDelay initial delay to start executing callback
* @param period after the initial delay after which the callback is executed
* @return Scheduled future representing the task to be executed repeatedly
*/
ScheduledFuture scheduleAtFixedRate(
ProcessingTimeCallback callback, long initialDelay, long period);
/**
* Registers a task to be executed repeatedly with a fixed delay.
*
*
This call behaves similar to {@link ScheduledExecutor#scheduleWithFixedDelay(Runnable,
* long, long, TimeUnit)}.
*
* @param callback to be executed after the initial delay and then after each period
* @param initialDelay initial delay to start executing callback
* @param period after the initial delay after which the callback is executed
* @return Scheduled future representing the task to be executed repeatedly
*/
ScheduledFuture scheduleWithFixedDelay(
ProcessingTimeCallback callback, long initialDelay, long period);
/**
* This method puts the service into a state where it does not register new timers, but returns
* for each call to {@link #registerTimer} or {@link #scheduleAtFixedRate} a "mock" future and
* the "mock" future will be never completed. Furthermore, the timers registered before are
* prevented from firing, but the timers in running are allowed to finish.
*
*
If no timer is running, the quiesce-completed future is immediately completed and
* returned. Otherwise, the future returned will be completed when all running timers have
* finished.
*/
CompletableFuture quiesce();
}