com.github.kristofa.brave.ClientSpanThreadBinder Maven / Gradle / Ivy

Go to download
package com.github.kristofa.brave;


import com.twitter.zipkin.gen.Span;

/**
 * Allows binding span from client request thread to a async callback thread that process the result.
 * 
 * To be used for async client call the result of which is processed in a separate callback thread.
 * After calling {@link ClientTracer#startNewSpan(String)}, call getCurrentClientSpan() and save the result to pass to the
 * callback method (e.g., local final variable)
 * In the callback method, call {@link #setCurrentSpan} before calling {@link com.github.kristofa.brave.ClientTracer#setClientReceived()}
 * @author hzhao on 8/11/14.
 */

public interface ClientSpanThreadBinder
{

    /**
     * This should be called in the thread in which the client request made after starting new client span.
     * 
     * It returns the current client span which you can keep and bind to the callback thread
     * @see #setCurrentSpan(Span)
     * @return Returned Span can be bound to different callback thread.
     */
    Span getCurrentClientSpan();


    /**
     * Binds given span to current thread. This should typically be called when code is invoked in async client callback
     * before the {@link ClientTracer#setClientReceived()}
     *
     * @param span Span to bind to current execution thread. Should not be null.
     */
    void setCurrentSpan(final Span span);

}