org.apache.solr.client.solrj.util.Cancellable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of solr-solrj Show documentation

Apache Solr Solrj

There is a newer version: 9.7.0

/*
 * 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.solr.client.solrj.util;

/**
 * The return type for solrJ asynchronous requests, providing a mechanism whereby callers may
 * request cancellation.
 *
 * @deprecated Use the async variants that return CompletableFuture.
 */
@Deprecated
public interface Cancellable {

  /**
   * Request to cancel the asynchronous request. This may be a no-op in some situations, for
   * instance, if the request failed or otherwise is complete.
   */
  void cancel();
}