PlatformThreadContextElement

kotlin.Any
   ↳ 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 functions
open CoroutineContext.Element?
Cmn

Public properties
open String

The category that a trace section belongs to.
Cmn
open List<Long>

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

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

The Tracer instance that can use this PropagationToken for context propagation when the coroutine suspends and resumes.
Cmn

Inherited functions
From kotlin.AutoCloseable
abstract Unit
Cmn
From kotlin.coroutines.CoroutineContext
open operator CoroutineContext
Cmn
From kotlin.coroutines.CoroutineContext.Element
open R
<R : Any?> fold(initial: R, operation: (CoroutineContext.Element, R) -> R)
Cmn
open operator E?
Cmn
open CoroutineContext
Cmn

Inherited properties
From kotlin.coroutines.AbstractCoroutineContextElement
open CoroutineContext.Key<*>
Cmn

Public functions

contextElementOrNull

Cmn 
@DelicateTracingApi
open fun contextElementOrNull(): CoroutineContext.Element?
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 properties

category

Cmn
Added in 2.0.0-alpha03
open var category: String

The category that a trace section belongs to.

flowIds

Cmn
Added in 2.0.0-alpha03
open val flowIds: List<Long>

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

name

Cmn
Added in 2.0.0-alpha03
open var name: String

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

tracer

Cmn
Added in 2.0.0-alpha03
open val tracer: T

The Tracer instance that can use this PropagationToken for context propagation when the coroutine suspends and resumes.