com.hazelcast.internal.util.scheduler.EntryTaskScheduler Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2020, 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.internal.util.scheduler;
/**
* Schedules (or reschedules) the execution of given entry.
*
* @param key type of related entries
* @param value type of related entries
*/
public interface EntryTaskScheduler {
/**
* Schedules (or reschedules) the execution of given entry. Key parameter is
* used to check whether there is an existing scheduling for this entry, see
* {@link ScheduleType} for possible behaviours in such case.
*
* @param delayMillis milliseconds to delay the execution.
* @param key key of this scheduling.
* @param object user object to pass back when it is time to execute.
* @return returns true if this call resulted in a new scheduling,
* false otherwise.
*/
boolean schedule(long delayMillis, K key, V object);
/**
* Cancel all scheduled executions with the given key.
*
* @param key the scheduled key
* @return the cancelled scheduled execution, in case of {@link ScheduleType#FOR_EACH} a random one will be returned,
* or {@code null} if nothing was scheduled or everything already executed for this key
*/
ScheduledEntry cancel(K key);
/**
* Cancels the scheduled executions for the given key and value if present. The method returns the number of cancelled
* scheduled entries.
*
* @param key the scheduled key
* @param value the scheduled value
* @return the number of cancelled scheduled entries.
*/
int cancelIfExists(K key, V value);
/**
* Return the entry for the scheduled key.
* @param key the scheduled key
* @return the scheduled execution, in case of {@link ScheduleType#FOR_EACH} a random one will be returned,
* or {@code null} if nothing was scheduled or everything already executed for this key
*/
ScheduledEntry get(K key);
/** Cancel all scheduled executions */
void cancelAll();
}