AsyncJsonCommand.java

/**
 * diqube: Distributed Query Base.
 *
 * Copyright (C) 2015 Bastian Gloeckle
 *
 * This file is part of diqube.
 *
 * diqube is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.diqube.ui.websocket.request.commands;

import org.diqube.ui.websocket.request.CommandClusterInteraction;

/**
 * An asynchronous {@link JsonCommand} executes the logic asynchronously.
 *
 * @author Bastian Gloeckle
 */
public interface AsyncJsonCommand extends JsonCommand {
  /**
   * If the command is still executing, try the best to cancel the execution.
   * 
   * @param clusterInteraction
   *          interaction with the cluster.
   */
  public void cancel(CommandClusterInteraction clusterInteraction);
}