AbstractTraceDriver

Kotlin |Java

public abstract class AbstractTraceDriver implements AutoCloseable

Known direct subclasses

TraceDriver

The entry point to tracing APIs.

The entry point for the tracing API.

Summary

Protected constructors
`AbstractTraceDriver(@NonNull AbstractTraceSink sink, boolean isEnabled)` Builds an instance of `AbstractTraceDriver` using the provided `AbstractTraceSink` if `isEnabled` is `true`.

Public methods
`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.
`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.

protected AbstractTraceDriver(@NonNull AbstractTraceSink sink, boolean isEnabled)

Builds an instance of AbstractTraceDriver using the provided AbstractTraceSink if isEnabled is true. Otherwise, you get an instance of a no-op AbstractTraceDriver.

public abstract void close()

Flushes all outstanding packets to the AbstractTraceSink and then closes the AbstractTraceSink.

public abstract void flush()

Flushes the trace packets into the underlying AbstractTraceSink.

public final @NonNull AbstractTraceSink getSink()

The AbstractTraceSink that asynchronously serializes trace events to a file or buffer, depending on implementation.

public abstract @NonNull Tracer getTracer()

Return an instance of a Tracer that can be used to emit trace events.

public final boolean isEnabled()

When isEnabled is true, then the Tracer obtained from the AbstractTraceDriver emits trace events. Otherwise, no events are emitted.