zipkin.storage.AsyncSpanConsumer Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2015-2017 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.storage;

import java.util.List;
import zipkin.Codec;
import zipkin.Span;

/**
 * Spans are created in instrumentation, transported out-of-band, and eventually persisted. A span
 * consumer is a stage along that pipeline. A common consumption case in zipkin is to write spans to
 * storage after applying sampling policy.
 *
 * This accepts a {@link Callback } to allow bridging to async libraries.
 */
// @FunctionalInterface
public interface AsyncSpanConsumer {

  /** Stores a list of spans {@link Codec#readSpans(byte[]) read} from a transport. */
  void accept(List spans, Callback callback);
}