PlatformThreadContextElement

Kotlin |Java

public abstract class PlatformThreadContextElement extends AbstractCoroutineContextElement implements PropagationToken, AutoCloseable

java.lang.Object
↳	kotlin.coroutines.AbstractCoroutineContextElement
	↳	androidx.tracing.PlatformThreadContextElement

We use the PlatformThreadContextElement construct to know when a coroutine has suspended, and about to resume on a Thread.

Summary

Public methods
`void`	`close()`
`CoroutineContext.Element`	`@DelicateTracingApi contextElementOrNull()`
`@NonNull String`	`getCategory()` The `category` that a trace section belongs to.
`@NonNull List<@NonNull Long>`	`getFlowIds()` The underlying Perfetto flow ids that can be used to determine the causality for a given trace section.
`@NonNull String`	`getName()` The `name` of the code section as it appears in a trace.
`void`	`setCategory(@NonNull String value)` The `category` that a trace section belongs to.
`void`	`setName(@NonNull String value)` The `name` of the code section as it appears in a trace.

@NonNull CoroutineContext.Key<@NonNull ?>

getKey()

@NonNull CoroutineContext

plus(@NonNull CoroutineContext context)

`@NonNull R`	`<R extends Object> fold( @NonNull R initial, @NonNull Function2<@NonNull R, @NonNull CoroutineContext.Element, @NonNull R> operation )`
`E`	`<E extends CoroutineContext.Element> get( @NonNull CoroutineContext.Key<@NonNull E> key )`
`@NonNull CoroutineContext`	`minusKey(@NonNull CoroutineContext.Key<@NonNull ?> key)`

public void close()

@DelicateTracingApi
public CoroutineContext.Element contextElementOrNull()

Returns
`CoroutineContext.Element`	a `CoroutineContext.Element` that needs to be installed in the `kotlinx.coroutines.currentCoroutineContext` prior to dispatching the suspending block of code being traced; if the token is being used in a suspending context.

public @NonNull String getCategory()

The category that a trace section belongs to.

public @NonNull List<@NonNull Long> getFlowIds()

The underlying Perfetto flow ids that can be used to determine the causality for a given trace section.

public @NonNull String getName()

The name of the code section as it appears in a trace.

public void setCategory(@NonNull String value)

The category that a trace section belongs to.

public void setName(@NonNull String value)

The name of the code section as it appears in a trace.