TraceSink

Kotlin |Java

Cmn
```
class TraceSink : AbstractTraceSink
```

kotlin.Any
↳	androidx.tracing.AbstractTraceSink
	↳	androidx.tracing.wire.TraceSink

The trace sink that writes BufferedSink, to a new file per trace session.

This implementation converts androidx.tracing.TraceEvents into binary protos using the Wire library.

The outputs created by TraceSink can be visualized with ui.perfetto.dev, and queried by TraceProcessor from the androidx.benchmark:benchmark-traceprocessor library, the C++ tool it's built on, or the Python wrapper.

As binary protos embed strings as UTF-8, note that any strings serialized by TraceSink will be serialized as UTF-8.

Summary

Public constructors
`TraceSink( sequenceId: @IntRange(from = 1) Int, bufferedSink: BufferedSink, coroutineContext: CoroutineContext )` Constructs an instance of `TraceSink`.	Cmn
`TraceSink( sequenceId: @IntRange(from = 1) Int, sinkProvider: () -> BufferedSink, coroutineContext: CoroutineContext )`	Cmn

Public functions
`open Unit`	`close()` Close the `AbstractTraceSink`, completing any enqueued writes.	Cmn
`open Unit`	`enqueue(pooledPacketArray: PooledTracePacketArray)` Enqueue a `PooledTracePacketArray` to be written to the trace.	Cmn
`open Unit`	`flush()` Flush any enqueued trace events to the `AbstractTraceSink`.	Cmn
`open Unit`	`onDroppedTraceEvent()` Called when the `AbstractTraceSink` cannot keep up with incoming trace events from `Track`s.	Cmn

Public constructors

TraceSink

Cmn

Added in 2.0.0-alpha09

TraceSink(
    sequenceId: @IntRange(from = 1) Int,
    bufferedSink: BufferedSink,
    coroutineContext: CoroutineContext
)

Constructs an instance of TraceSink.

Parameters
`sequenceId: @IntRange(from = 1) Int`	ID which uniquely identifies the trace capture system. Value must be greater than 0.
`bufferedSink: BufferedSink`	The `BufferedSink` that the trace will be written to.
`coroutineContext: CoroutineContext`	The `CoroutineContext` to execute the serialization on.

TraceSink

Cmn

TraceSink(
    sequenceId: @IntRange(from = 1) Int,
    sinkProvider: () -> BufferedSink,
    coroutineContext: CoroutineContext = NonCancellable + Dispatchers.IO
)

Public functions

close

Cmn

Added in 2.0.0-alpha09

open fun close(): Unit

Close the AbstractTraceSink, completing any enqueued writes.

This function may be called from any thread.

enqueue

Cmn

Added in 2.0.0-alpha09

open fun enqueue(pooledPacketArray: PooledTracePacketArray): Unit

Enqueue a PooledTracePacketArray to be written to the trace.

This function may be called from any thread.

flush

Cmn

Added in 2.0.0-alpha09

open fun flush(): Unit

Flush any enqueued trace events to the AbstractTraceSink.

If the trace sink writes to persistent storage, this forces any buffered events to be written immediately. For in-memory sinks, this is typically a no-op because they do not have an underlying persistent storage destination by default.

This function may be called from any thread.

onDroppedTraceEvent

Cmn

Added in 2.0.0-alpha09

open fun onDroppedTraceEvent(): Unit

Called when the AbstractTraceSink cannot keep up with incoming trace events from Tracks.

This function may be called from any thread.