androidx.tracing.wire


Classes

TraceSink

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

Cmn

Top-level functions summary

TraceDriver
TraceDriver(sink: TraceSink, isEnabled: Boolean)

Constructs a TraceDriver instance on the JVM.

android
TraceDriver
TraceDriver(context: Context, sink: TraceSink, isEnabled: Boolean)

Constructs a TraceDriver instance on Android based on the provided Context instance.

android
TraceSink
TraceSink(
    directory: File,
    sequenceId: Int,
    coroutineContext: CoroutineContext
)
android
TraceSink
TraceSink(
    context: Context,
    sequenceId: Int,
    coroutineContext: CoroutineContext,
    outputStream: OutputStream
)
android
TraceSink
TraceSink(
    context: Context,
    sequenceId: Int,
    coroutineContext: CoroutineContext,
    traceFile: File
)
android

Top-level functions

TraceDriver

fun TraceDriver(sink: TraceSink, isEnabled: Boolean = true): TraceDriver

Constructs a TraceDriver instance on the JVM.

Parameters
sink: TraceSink

The TraceSink instance.

isEnabled: Boolean = true

Set this to true to emit trace events. false disables all tracing to lower overhead.

TraceDriver

fun TraceDriver(context: Context, sink: TraceSink, isEnabled: Boolean = true): TraceDriver

Constructs a TraceDriver instance on Android based on the provided Context instance.

Parameters
context: Context

The Android app Context.

sink: TraceSink

The TraceSink instance.

isEnabled: Boolean = true

Set this to true to emit trace events. false disables all tracing to lower overhead.

TraceSink

fun TraceSink(
    directory: File,
    sequenceId: Int,
    coroutineContext: CoroutineContext = Dispatchers.IO
): TraceSink

TraceSink

fun TraceSink(
    context: Context,
    sequenceId: Int,
    coroutineContext: CoroutineContext,
    outputStream: OutputStream
): TraceSink

TraceSink

fun TraceSink(
    context: Context,
    sequenceId: Int,
    coroutineContext: CoroutineContext,
    traceFile: File = context.filesDir.perfettoTraceFile()
): TraceSink