com.facebook.litho

Interface WorkContinuationInstrumenter.Instrumenter

Enclosing class:

WorkContinuationInstrumenter

public static interface WorkContinuationInstrumenter.Instrumenter

Allows to record work being continued across threads.

Method Summary

Modifier and Type	Method and Description
boolean	isTracing() Allows to know in advance if the custom instrumenter desires to receive continuation updates.
void	markFailure(java.lang.Object token, java.lang.Throwable th) Reports a failure while executing work.
java.lang.Object	onAskForWorkToContinue(java.lang.String tag) Captures when asking for work to be stolen.
java.lang.Object	onBeginWorkContinuation(java.lang.String tag, java.lang.Object token) Captures the beginning of the continuation for stolen work.
void	onEndWorkContinuation(java.lang.Object token) Captures the end of the continuation for stolen work.
java.lang.Object	onOfferWorkForContinuation(java.lang.String tag) Tracks when some work is ready to offered for continuation.
java.lang.Object	onOfferWorkForContinuation(java.lang.String tag, java.lang.Object token) Tracks when some work is ready to be stolen.

Method Detail

isTracing

boolean isTracing()

Allows to know in advance if the custom instrumenter desires to receive continuation updates.

Returns:

true to specify interest in handling the updates, false otherwise.

onAskForWorkToContinue

java.lang.Object onAskForWorkToContinue(java.lang.String tag)

Captures when asking for work to be stolen.

Parameters:

tag - name.

Returns:

a token object that allows to track the continuation.

onOfferWorkForContinuation

java.lang.Object onOfferWorkForContinuation(java.lang.String tag)

Tracks when some work is ready to offered for continuation.

Parameters:

tag - name.

Returns:

a token object that allows to track the continuation.

onOfferWorkForContinuation

java.lang.Object onOfferWorkForContinuation(java.lang.String tag,
                                            java.lang.Object token)

Tracks when some work is ready to be stolen.

Parameters:

tag - name (optional).

token - returned by onAskForWorkToContinue(java.lang.String).

Returns:

a token object that allows to track the continuation.

onBeginWorkContinuation

java.lang.Object onBeginWorkContinuation(java.lang.String tag,
                                         java.lang.Object token)

Captures the beginning of the continuation for stolen work.

Parameters:

tag - name (optional).

token - returned by onOfferWorkForContinuation(java.lang.String).

Returns:

a token object that allows to track the continuation.

onEndWorkContinuation

void onEndWorkContinuation(java.lang.Object token)

Captures the end of the continuation for stolen work.

Parameters:

token - returned by onBeginWorkContinuation(java.lang.String, java.lang.Object).

markFailure

void markFailure(java.lang.Object token,
                 java.lang.Throwable th)

Reports a failure while executing work.

onEndWorkContinuation(Object) (Object)} still needs to be invoked.

Parameters:

token - returned by onBeginWorkContinuation(String, Object) (Object, String)}.

th - containing the failure.