TraceDriver

Kotlin |Java

public final class TraceDriver extends AbstractTraceDriver

java.lang.Object
↳	androidx.tracing.AbstractTraceDriver
	↳	androidx.tracing.wire.TraceDriver

The entry point to tracing APIs.

Summary

Public constructors
`TraceDriver(@NonNull AbstractTraceSink sink, boolean isEnabled)`
`TraceDriver( @NonNull Context context, @NonNull AbstractTraceSink sink, boolean isEnabled )`

Public methods
`void`	`close()` Flushes all outstanding packets to the `AbstractTraceSink` and then closes the `AbstractTraceSink`.
`void`	`close()` Flushes all outstanding packets to the `AbstractTraceSink` and then closes the `AbstractTraceSink`.
`void`	`flush()` Flushes the trace packets into the underlying `AbstractTraceSink`.
`void`	`flush()` Flushes the trace packets into the underlying `AbstractTraceSink`.
`@NonNull Tracer`	`getTracer()` Return an instance of a `Tracer` that can be used to emit trace events.
`@NonNull Tracer`	`getTracer()` Return an instance of a `Tracer` that can be used to emit trace events.

`abstract void`	`close()` Flushes all outstanding packets to the `AbstractTraceSink` and then closes the `AbstractTraceSink`.
`abstract void`	`flush()` Flushes the trace packets into the underlying `AbstractTraceSink`.
`final @NonNull AbstractTraceSink`	`getSink()` The `AbstractTraceSink` that asynchronously serializes trace events to a file or buffer, depending on implementation.
`final @NonNull AbstractTraceSink`	`getSink()` The `AbstractTraceSink` that asynchronously serializes trace events to a file or buffer, depending on implementation.
`final @NonNull AbstractTraceSink`	`getSink()` The `AbstractTraceSink` that asynchronously serializes trace events to a file or buffer, depending on implementation.
`abstract @NonNull Tracer`	`getTracer()` Return an instance of a `Tracer` that can be used to emit trace events.
`final boolean`	`isEnabled()` When `isEnabled` is `true`, then the `Tracer` obtained from the `AbstractTraceDriver` emits trace events.
`final boolean`	`isEnabled()` When `isEnabled` is `true`, then the `Tracer` obtained from the `AbstractTraceDriver` emits trace events.
`final boolean`	`isEnabled()` When `isEnabled` is `true`, then the `Tracer` obtained from the `AbstractTraceDriver` emits trace events.

public TraceDriver(@NonNull AbstractTraceSink sink, boolean isEnabled)

Parameters
`@NonNull AbstractTraceSink sink`	The `TraceSink` instance.
`boolean isEnabled`	Set this to `true` to emit trace events. `false` disables all tracing to lower overhead.

public TraceDriver(
    @NonNull Context context,
    @NonNull AbstractTraceSink sink,
    boolean isEnabled
)

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