com.google.gwt.core.client.impl

Class AsyncFragmentLoader

java.lang.Object

com.google.gwt.core.client.impl.AsyncFragmentLoader

public class AsyncFragmentLoader
extends Object

Low-level support to download an extra fragment of code. This should not be invoked directly by user code.

The fragments are numbered as follows, assuming there are m split points:

• 0 -- the base fragment, which is initially downloaded
• 1..m -- fragments for each split point
• m+1 -- the leftovers fragment of code that goes nowhere else

Since the precise way to load code depends on the linker, linkers should specify a rebind of AsyncFragmentLoader.LoadingStrategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AsyncFragmentLoader.LoadingStrategy A strategy for loading code fragments.
static interface	AsyncFragmentLoader.LoadTerminatedHandler An interface for handlers of load completion.
static interface	AsyncFragmentLoader.Logger A strategy for logging progress.
static class	AsyncFragmentLoader.LwmLabels Labels used for runAsync lightweight metrics.
static class	AsyncFragmentLoader.StandardLogger The standard logger used in a web browser.

Field Summary

Fields

Modifier and Type	Field and Description
static AsyncFragmentLoader	BROWSER_LOADER The standard instance of AsyncFragmentLoader used in a web browser.

Constructor Summary

Constructors

Constructor and Description
AsyncFragmentLoader(int numEntries, int[] initialLoadSequence, AsyncFragmentLoader.LoadingStrategy loadingStrategy, AsyncFragmentLoader.Logger logger, com.google.gwt.core.client.impl.OnSuccessExecutor executor)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isAlreadyLoaded(int splitPoint)
static void	onLoad(int fragment) Called by compiler-generated code when a fragment is loaded.
static void	runAsync(int fragment, RunAsyncCallback callback) Called by the compiler to implement GWT.runAsync(java.lang.Class<?>, com.google.gwt.core.client.RunAsyncCallback).
void	setPrefetchQueue(int... runAsyncSplitPoints) Request that a sequence of split points be prefetched.
void	startPrefetching()
void	stopPrefetching()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

BROWSER_LOADER

public static AsyncFragmentLoader BROWSER_LOADER

The standard instance of AsyncFragmentLoader used in a web browser. Outside of GWT generated JavaScript (i.e our vanilla JUnit tests, or if referenced in a server context), this field is null. When compiled to JavaScript, the parameters to this call are rewritten by com.google.gwt.dev.jjs.impl.codesplitter.ReplaceRunAsyncs. So this must be a method call of exactly two arguments to succeed when invoked in web mode.

Constructor Detail

AsyncFragmentLoader

public AsyncFragmentLoader(int numEntries,
                   int[] initialLoadSequence,
                   AsyncFragmentLoader.LoadingStrategy loadingStrategy,
                   AsyncFragmentLoader.Logger logger,
                   com.google.gwt.core.client.impl.OnSuccessExecutor executor)

Method Detail

onLoad

public static void onLoad(int fragment)

Called by compiler-generated code when a fragment is loaded.

Parameters:

fragment - the fragment number

runAsync

public static void runAsync(int fragment,
            RunAsyncCallback callback)

Called by the compiler to implement GWT.runAsync(java.lang.Class<?>, com.google.gwt.core.client.RunAsyncCallback).

Parameters:

fragment - the fragment number

callback - the callback to run

isAlreadyLoaded

public boolean isAlreadyLoaded(int splitPoint)

setPrefetchQueue

public void setPrefetchQueue(int... runAsyncSplitPoints)

Request that a sequence of split points be prefetched. Code for the split points in splitPoints will be downloaded and installed whenever there is nothing else to download. Each call to this method overwrites the entire prefetch queue with the newly specified one.

startPrefetching

public void startPrefetching()

stopPrefetching

public void stopPrefetching()