hazelcast-master/hazelcast/src/main/java/com/hazelcast/map/impl/querycache/QueryCacheScheduler.java
/*
 * Copyright (c) 2008-2023, Hazelcast, 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 com.hazelcast.map.impl.querycache;

import com.hazelcast.map.impl.querycache.accumulator.AccumulatorProcessor;

import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ScheduledFuture;

/**
 * Scheduler abstraction to allow different type of implementations
 * on query cache subscriber and query cache publisher sides.
 * <p>
 * Mainly used for offloading indexing-process and scheduling {@link AccumulatorProcessor}.
 */
public interface QueryCacheScheduler {

    /**
     * Executes a task.
     *
     * @param task task to execute.
     * @throws RejectedExecutionException if this task cannot be accepted for execution.
     */
    void execute(Runnable task);

    /**
     * Executes a task periodically with the supplied {@code delaySeconds}.
     *
     * @param task         task to execute.
     * @param delaySeconds the time between subsequent execution
     * @return a ScheduledFuture representing pending completion of
     * the task and whose <tt>get()</tt> method will return
     * <tt>null</tt> upon completion
     * @throws RejectedExecutionException if the task cannot be scheduled for execution
     */
    ScheduledFuture<?> scheduleWithRepetition(Runnable task, long delaySeconds);

    /**
     * Shuts down this scheduler.
     */
    void shutdown();
}
