zipkin.reporter.Callback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zipkin-reporter Show documentation

There is a newer version: 1.1.2

/**
 * Copyright 2016 The OpenZipkin Authors
 *
 * 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 zipkin.reporter;

/**
 * A callback of completion or error. Typical use is incrementing spans dropped metrics.
 *
 * This is a bridge to async libraries such as CompletableFuture complete,
 * completeExceptionally.
 *
 * 
Implementations will call either {@link #onComplete} or {@link #onError}, but not both.
 */
public interface Callback {

  /**
   * Invoked when computation completed successfully.
   *
   * 
When this is called, {@link #onError} won't be.
   */
  void onComplete();

  /**
   * Invoked when computation completed abnormally.
   *
   * When this is called, {@link #onComplete} won't be.
   */
  void onError(Throwable t);
}