TraceDriver

Kotlin |Java

kotlin.Any
↳	androidx.tracing.AbstractTraceDriver
	↳	androidx.tracing.wire.TraceDriver

The entry point to tracing APIs.

Summary

Public constructors
`TraceDriver(sink: AbstractTraceSink, isEnabled: Boolean)`	android
`TraceDriver(context: Context, sink: AbstractTraceSink, isEnabled: Boolean)`	android

Public functions
`open Unit`	`close()` Flushes all outstanding packets to the `AbstractTraceSink` and then closes the `AbstractTraceSink`.	android
`open Unit`	`close()` Flushes all outstanding packets to the `AbstractTraceSink` and then closes the `AbstractTraceSink`.	android
`open Unit`	`flush()` Flushes the trace packets into the underlying `AbstractTraceSink`.	android
`open Unit`	`flush()` Flushes the trace packets into the underlying `AbstractTraceSink`.	android

Public properties
`open Tracer`	`tracer` Return an instance of a `Tracer` that can be used to emit trace events.	android
`open Tracer`	`tracer` Return an instance of a `Tracer` that can be used to emit trace events.	android

`abstract Unit`	`close()` Flushes all outstanding packets to the `AbstractTraceSink` and then closes the `AbstractTraceSink`.	Cmn
`abstract Unit`	`flush()` Flushes the trace packets into the underlying `AbstractTraceSink`.	Cmn

`Boolean`	`isEnabled` When `isEnabled` is `true`, then the `Tracer` obtained from the `AbstractTraceDriver` emits trace events.	android
`Boolean`	`isEnabled` When `isEnabled` is `true`, then the `Tracer` obtained from the `AbstractTraceDriver` emits trace events.	Cmn
`Boolean`	`isEnabled` When `isEnabled` is `true`, then the `Tracer` obtained from the `AbstractTraceDriver` emits trace events.	android
`AbstractTraceSink`	`sink` The `AbstractTraceSink` that asynchronously serializes trace events to a file or buffer, depending on implementation.	android
`AbstractTraceSink`	`sink` The `AbstractTraceSink` that asynchronously serializes trace events to a file or buffer, depending on implementation.	Cmn
`AbstractTraceSink`	`sink` The `AbstractTraceSink` that asynchronously serializes trace events to a file or buffer, depending on implementation.	android
`abstract Tracer`	`tracer` Return an instance of a `Tracer` that can be used to emit trace events.	Cmn

android

TraceDriver(sink: AbstractTraceSink, isEnabled: Boolean = true)

Parameters
`sink: AbstractTraceSink`	The `TraceSink` instance.
`isEnabled: Boolean = true`	Set this to `true` to emit trace events. `false` disables all tracing to lower overhead.

android

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

Parameters
`context: Context`	The Android application `Context`.
`sink: AbstractTraceSink`	The `TraceSink` instance.
`isEnabled: Boolean = true`	Set this to `true` to emit trace events. `false` disables all tracing to lower overhead.