com.facebook.litho

Class ComponentsSystrace

java.lang.Object

com.facebook.litho.ComponentsSystrace

public class ComponentsSystrace
extends java.lang.Object

This is intended as a hook into android.os.Trace, but allows you to provide your own functionality. Use it as

ComponentsSystrace.beginSection("tag"); ... ComponentsSystrace.endSection(); As a default, it simply calls android.os.Trace (see DefaultComponentsSystrace). You may supply your own with provide(Systracer).

Method Summary

Modifier and Type	Method and Description
static void	beginAsyncSection(java.lang.String name) Writes a trace message to indicate that a given section of code has begun.
static void	beginAsyncSection(java.lang.String name, int cookie) Writes a trace message to indicate that a given section of code has begun.
static void	beginSection(java.lang.String name) Writes a trace message to indicate that a given section of code has begun.
static Systracer.ArgsBuilder	beginSectionWithArgs(java.lang.String name)
static void	endAsyncSection(java.lang.String name) Writes a trace message to indicate that the current method has ended.
static void	endAsyncSection(java.lang.String name, int cookie) Writes a trace message to indicate that the current method has ended.
static void	endSection() Writes a trace message to indicate that a given section of code has ended.
static Systracer	getSystrace()
static boolean	isTracing()
static void	provide(Systracer instance) This should be called exactly once at app startup, before any Litho work happens.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

provide

public static void provide(Systracer instance)

This should be called exactly once at app startup, before any Litho work happens.

getSystrace

public static Systracer getSystrace()

beginSection

public static void beginSection(java.lang.String name)

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.

beginAsyncSection

public static void beginAsyncSection(java.lang.String name)

Writes a trace message to indicate that a given section of code has begun. Must be followed by a call to endAsyncSection(String) using the same tag. Unlike beginSection(String) 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.

Depending on provided Systracer instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

beginAsyncSection

public static void beginAsyncSection(java.lang.String name,
                                     int cookie)

Writes a trace message to indicate that a given section of code has begun. Must be followed by a call to endAsyncSection(String, int) using the same tag. Unlike beginSection(String) 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.

Depending on provided Systracer instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

beginSectionWithArgs

public static Systracer.ArgsBuilder beginSectionWithArgs(java.lang.String name)

endSection

public static void endSection()

Writes a trace message to indicate that a given section of code has ended. This call must be preceded by a corresponding call to beginSection(String). 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.

endAsyncSection

public static void endAsyncSection(java.lang.String name)

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

Depending on provided Systracer instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

endAsyncSection

public static void endAsyncSection(java.lang.String name,
                                   int cookie)

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

Depending on provided Systracer instance, this method could vary in behavior and in DefaultComponentsSystrace it is a no-op.

isTracing

public static boolean isTracing()