Skip to content

Commit 5ae8611

Browse files
OliverO2pablobaxter
authored andcommitted
Fix example code in comment of CopyableThreadContextElement (Kotlin#3157)
1 parent cadd49b commit 5ae8611

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

kotlinx-coroutines-core/jvm/src/ThreadContextElement.kt

+7-8
Original file line numberDiff line numberDiff line change
@@ -97,26 +97,25 @@ public interface ThreadContextElement<S> : CoroutineContext.Element {
9797
* is in a coroutine:
9898
*
9999
* ```
100-
* class TraceContextElement(val traceData: TraceData?) : CopyableThreadContextElement<TraceData?> {
101-
* companion object Key : CoroutineContext.Key<ThreadTraceContextElement>
102-
* override val key: CoroutineContext.Key<ThreadTraceContextElement>
103-
* get() = Key
100+
* class TraceContextElement(private val traceData: TraceData?) : CopyableThreadContextElement<TraceData?> {
101+
* companion object Key : CoroutineContext.Key<TraceContextElement>
102+
* override val key: CoroutineContext.Key<TraceContextElement> = Key
104103
*
105104
* override fun updateThreadContext(context: CoroutineContext): TraceData? {
106105
* val oldState = traceThreadLocal.get()
107-
* traceThreadLocal.set(data)
106+
* traceThreadLocal.set(traceData)
108107
* return oldState
109108
* }
110109
*
111-
* override fun restoreThreadContext(context: CoroutineContext, oldData: TraceData?) {
110+
* override fun restoreThreadContext(context: CoroutineContext, oldState: TraceData?) {
112111
* traceThreadLocal.set(oldState)
113112
* }
114113
*
115-
* override fun copyForChildCoroutine(): CopyableThreadContextElement<MyData?> {
114+
* override fun copyForChildCoroutine(): CopyableThreadContextElement<TraceData?> {
116115
* // Copy from the ThreadLocal source of truth at child coroutine launch time. This makes
117116
* // ThreadLocal writes between resumption of the parent coroutine and the launch of the
118117
* // child coroutine visible to the child.
119-
* return CopyForChildCoroutineElement(traceThreadLocal.get())
118+
* return TraceContextElement(traceThreadLocal.get()?.copy())
120119
* }
121120
* }
122121
* ```

0 commit comments

Comments
 (0)