com.alibaba.ttl

Class TransmittableThreadLocal<T>

java.lang.Object

java.lang.ThreadLocal<T>

java.lang.InheritableThreadLocal<T>

com.alibaba.ttl.TransmittableThreadLocal<T>

public class TransmittableThreadLocal<T>
extends InheritableThreadLocal<T>

TransmittableThreadLocal can transmit value from the thread of submitting task to the thread of executing task.

Note: this class extends InheritableThreadLocal, so TransmittableThreadLocal first is a InheritableThreadLocal.

Since:

0.10.0

Author:

Jerry Lee (oldratlee at gmail dot com)

See Also:

TtlRunnable, TtlCallable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransmittableThreadLocal.Transmitter TransmittableThreadLocal.Transmitter transmit all TransmittableThreadLocal of current thread to any other thread by static method TransmittableThreadLocal.Transmitter.capture() => TransmittableThreadLocal.Transmitter.replay(Object) => TransmittableThreadLocal.Transmitter.restore(Object) (aka CRR operation).

Constructor Summary

Constructors

Constructor and Description
TransmittableThreadLocal()

Method Summary

Modifier and Type	Method and Description
protected void	afterExecute() Callback method after task object(TtlRunnable/TtlCallable) execute.
protected void	beforeExecute() Callback method before task object(TtlRunnable/TtlCallable) execute.
protected T	copy(T parentValue) Computes the value for this transmittable thread-local variable as a function of the source thread's value at the time the task Object is created.
T	get()
void	remove()
void	set(T value)

Methods inherited from class java.lang.InheritableThreadLocal

childValue

Methods inherited from class java.lang.ThreadLocal

initialValue, withInitial

Methods inherited from class java.lang.Object

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

Constructor Detail

TransmittableThreadLocal

public TransmittableThreadLocal()

Method Detail

copy

protected T copy(T parentValue)

Computes the value for this transmittable thread-local variable as a function of the source thread's value at the time the task Object is created. This method is called from TtlRunnable or TtlCallable when it create, before the task is started.

This method merely returns reference of its source thread value, and should be overridden if a different behavior is desired.

Since:

1.0.0

beforeExecute

protected void beforeExecute()

Callback method before task object(TtlRunnable/TtlCallable) execute.

Default behavior is do nothing, and should be overridden if a different behavior is desired.

Do not throw any exception, just ignored.

Since:

1.2.0

afterExecute

protected void afterExecute()

Callback method after task object(TtlRunnable/TtlCallable) execute.

Default behavior is do nothing, and should be overridden if a different behavior is desired.

Do not throw any exception, just ignored.

Since:

1.2.0

get

public final T get()

Overrides:

get in class ThreadLocal<T>

set

public final void set(T value)

Overrides:

set in class ThreadLocal<T>

remove

public final void remove()

Overrides:

remove in class ThreadLocal<T>