AbstractTraceDriver


Known direct subclasses
TraceDriver

The entry point to tracing APIs.


The entry point for the tracing API.

Summary

Protected constructors

Builds an instance of AbstractTraceDriver using the provided AbstractTraceSink if isEnabled is true.

Cmn

Public functions

abstract Unit

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

Cmn
abstract Unit

Flushes the trace packets into the underlying AbstractTraceSink.

Cmn

Public properties

Boolean

When isEnabled is true, then the Tracer obtained from the AbstractTraceDriver emits trace events.

Cmn
AbstractTraceSink

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

Cmn
abstract Tracer

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

Cmn

Protected constructors

AbstractTraceDriver

protected AbstractTraceDriver(sink: AbstractTraceSink, isEnabled: Boolean)

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

Public functions

close

abstract fun close(): Unit

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

flush

abstract fun flush(): Unit

Flushes the trace packets into the underlying AbstractTraceSink.

Public properties

isEnabled

val isEnabledBoolean

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

sink

val sinkAbstractTraceSink

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

tracer

abstract val tracerTracer

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