org.jppf.node.protocol.CancellationHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jppf-common Show documentation

JPPF, the open source grid computing solution

There is a newer version: 6.3-alpha

/*
 * JPPF.
 * Copyright (C) 2005-2015 JPPF Team.
 * http://www.jppf.org
 *
 * 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 org.jppf.node.protocol;

/**
 * This interface should be implemented by tasks that wish a callback invoked as soon
 * as they are cancelled. This differs from the {@link org.jppf.node.protocol.Task#onCancel() Task.onCancel()}
 * callback in that {@code onCancel()} is called after the task has ended, whether the cancellation
 * succeeded or not.
 * @author Laurent Cohen
 * @since 5.0
 * @exclude
 */
public interface CancellationHandler {
  /**
   * Invoked immediately when a task is cancelled.
   * @throws Exception if any error occurs while this callback is executing.
   */
  void doCancelAction() throws Exception;
}