TraceCompat

Added in 1.1.0
Deprecated in 1.5.0

class TraceCompat


Writes trace events to the system trace buffer. These trace events can be collected and visualized using the Systrace tool.

This tracing mechanism is independent of the method tracing mechanism offered by startMethodTracing. In particular, it enables tracing of events that occur across multiple processes.

For information about using the Systrace tool, read Overview of system tracing.

Summary

Public functions

java-static Unit
beginAsyncSection(methodName: String, cookie: Int)

Writes a trace message to indicate that a given section of code has begun.

java-static Unit
beginSection(sectionName: String)

Writes a trace message to indicate that a given section of code has begun.

java-static Unit
endAsyncSection(methodName: String, cookie: Int)

Writes a trace message to indicate that the current method has ended.

java-static Unit

Writes a trace message to indicate that a given section of code has ended.

java-static Boolean

Checks whether or not tracing is currently enabled.

java-static Unit
setCounter(counterName: String, counterValue: Int)

Writes trace message to indicate the value of a given counter.

Public functions

beginAsyncSection

Added in 1.2.0
Deprecated in 1.5.0
java-static fun beginAsyncSection(methodName: String, cookie: Int): Unit

Writes a trace message to indicate that a given section of code has begun. Must be followed by a call to endAsyncSection with the same methodName and cookie. Unlike beginSection and endSection, asynchronous events do not need to be nested. The name and cookie used to begin an event must be used to end it.

Parameters
methodName: String

The method name to appear in the trace.

cookie: Int

Unique identifier for distinguishing simultaneous events

beginSection

Added in 1.1.0
Deprecated in 1.5.0
java-static fun beginSection(sectionName: String): Unit

Writes a trace message to indicate that a given section of code has begun. This call must be followed by a corresponding call to endSection on the same thread.

At this time the vertical bar character '|', newline character '\n', and null character '\0' are used internally by the tracing mechanism. If sectionName contains these characters they will be replaced with a space character in the trace.

Parameters
sectionName: String

The name of the code section to appear in the trace. This may be at most 127 Unicode code units long.

endAsyncSection

Added in 1.2.0
Deprecated in 1.5.0
java-static fun endAsyncSection(methodName: String, cookie: Int): Unit

Writes a trace message to indicate that the current method has ended. Must be called exactly once for each call to beginAsyncSection using the same name and cookie.

Parameters
methodName: String

The method name to appear in the trace.

cookie: Int

Unique identifier for distinguishing simultaneous events

endSection

Added in 1.1.0
Deprecated in 1.5.0
java-static fun endSection(): Unit

Writes a trace message to indicate that a given section of code has ended. This call must be preceeded by a corresponding call to beginSection. Calling this method will mark the end of the most recently begun section of code, so care must be taken to ensure that beginSection / endSection pairs are properly nested and called from the same thread.

isEnabled

Added in 1.2.0
Deprecated in 1.5.0
java-static fun isEnabled(): Boolean

Checks whether or not tracing is currently enabled. This is useful to avoid intermediate string creation for trace sections that require formatting. It is not necessary to guard all Trace method calls as they internally already check this. However it is recommended to use this to prevent creating any temporary objects that would then be passed to those methods to reduce runtime cost when tracing isn't enabled.

Returns
Boolean

true if tracing is currently enabled, false otherwise

setCounter

Added in 1.2.0
Deprecated in 1.5.0
java-static fun setCounter(counterName: String, counterValue: Int): Unit

Writes trace message to indicate the value of a given counter.

Parameters
counterName: String

The counter name to appear in the trace.

counterValue: Int

The counter value.