modules/core/src/main/java/org/apache/ignite/internal/processors/cache/persistence/metastorage/pendingtask/DurableBackgroundTask.java

/*
 * 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.ignite.internal.processors.cache.persistence.metastorage.pendingtask;

import java.io.Serializable;
import org.apache.ignite.internal.GridKernalContext;
import org.apache.ignite.internal.IgniteInternalFuture;

/**
 * Durable task that should be used to do long operations (e.g. index deletion) in background.
 */
public interface DurableBackgroundTask extends Serializable {
    /**
     * Getting the name of the task to identify it.
     * Also used as part of a key for storage in a MetaStorage.
     *
     * @return Task name.
     */
    String name();

    /**
     * Canceling the task.
     */
    void cancel();

    /**
     * Asynchronous task execution.
     *
     * Completion of the task execution should be only with the {@link DurableBackgroundTaskResult result}.
     *
     * @param ctx Kernal context.
     * @return Future of the tasks.
     */
    IgniteInternalFuture<DurableBackgroundTaskResult> executeAsync(GridKernalContext ctx);
}