com.github.kristofa.brave

Class ClientSpanThreadBinder

java.lang.Object

com.github.kristofa.brave.ClientSpanThreadBinder

public final class ClientSpanThreadBinder
extends Object

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 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 setCurrentSpan(com.twitter.zipkin.gen.Span) before calling ClientTracer.setClientReceived()

Author:

hzhao on 8/11/14.

Constructor Summary

Constructors

Constructor and Description
ClientSpanThreadBinder(ClientSpanState state) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Span	getCurrentClientSpan() This should be called in the thread in which the client request made after starting new client span.
void	setCurrentSpan(Span span) Binds given span to current thread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientSpanThreadBinder

public ClientSpanThreadBinder(ClientSpanState state)

Creates a new instance.

Parameters:

state - client span state, should not be null

Method Detail

getCurrentClientSpan

public Span getCurrentClientSpan()

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

Returns:

Returned Span can be bound to different callback thread.

See Also:

setCurrentSpan(Span)

setCurrentSpan

public void setCurrentSpan(Span span)

Binds given span to current thread. This should typically be called when code is invoked in async client callback before the ClientTracer.setClientReceived()

Parameters:

span - Span to bind to current execution thread. Should not be null.