com.bumptech.glide.load.engine

Class Engine

java.lang.Object

com.bumptech.glide.load.engine.Engine

All Implemented Interfaces:

MemoryCache.ResourceRemovedListener

public class Engine
extends Object
implements MemoryCache.ResourceRemovedListener

Responsible for starting loads and managing active and cached resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Engine.LoadStatus Allows a request to indicate it no longer is interested in a given load.

Constructor Summary

Constructors

Constructor and Description
Engine(MemoryCache memoryCache, DiskCache.Factory diskCacheFactory, ExecutorService diskCacheService, ExecutorService sourceService)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDiskCache()
<T,Z,R> Engine.LoadStatus	load(Key signature, int width, int height, DataFetcher<T> fetcher, DataLoadProvider<T,Z> loadProvider, Transformation<Z> transformation, ResourceTranscoder<Z,R> transcoder, Priority priority, boolean isMemoryCacheable, DiskCacheStrategy diskCacheStrategy, ResourceCallback cb) Starts a load for the given arguments.
void	onEngineJobCancelled(com.bumptech.glide.load.engine.EngineJob engineJob, Key key)
void	onEngineJobComplete(Key key, com.bumptech.glide.load.engine.EngineResource<?> resource)
void	onResourceReleased(Key cacheKey, com.bumptech.glide.load.engine.EngineResource resource)
void	onResourceRemoved(Resource<?> resource)
void	release(Resource resource)

Methods inherited from class java.lang.Object

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

Constructor Detail

Engine

public Engine(MemoryCache memoryCache,
      DiskCache.Factory diskCacheFactory,
      ExecutorService diskCacheService,
      ExecutorService sourceService)

Method Detail

load

public <T,Z,R> Engine.LoadStatus load(Key signature,
                             int width,
                             int height,
                             DataFetcher<T> fetcher,
                             DataLoadProvider<T,Z> loadProvider,
                             Transformation<Z> transformation,
                             ResourceTranscoder<Z,R> transcoder,
                             Priority priority,
                             boolean isMemoryCacheable,
                             DiskCacheStrategy diskCacheStrategy,
                             ResourceCallback cb)

Starts a load for the given arguments. Must be called on the main thread.

The flow for any request is as follows:

• Check the memory cache and provide the cached resource if present
• Check the current set of actively used resources and return the active resource if present
• Check the current set of in progress loads and add the cb to the in progress load if present
• Start a new load

Active resources are those that have been provided to at least one request and have not yet been released. Once all consumers of a resource have released that resource, the resource then goes to cache. If the resource is ever returned to a new consumer from cache, it is re-added to the active resources. If the resource is evicted from the cache, its resources are recycled and re-used if possible and the resource is discarded. There is no strict requirement that consumers release their resources so active resources are held weakly.

Type Parameters:

T - The type of data the resource will be decoded from.

Z - The type of the resource that will be decoded.

R - The type of the resource that will be transcoded from the decoded resource.

Parameters:

signature - A non-null unique key to be mixed into the cache key that identifies the version of the data to be loaded.

width - The target width in pixels of the desired resource.

height - The target height in pixels of the desired resource.

fetcher - The fetcher to use to retrieve data not in the disk cache.

loadProvider - The load provider containing various encoders and decoders use to decode and encode data.

transformation - The transformation to use to transform the decoded resource.

transcoder - The transcoder to use to transcode the decoded and transformed resource.

priority - The priority with which the request should run.

isMemoryCacheable - True if the transcoded resource can be cached in memory.

diskCacheStrategy - The strategy to use that determines what type of data, if any, will be cached in the local disk cache.

cb - The callback that will be called when the load completes.

release

public void release(Resource resource)

onEngineJobComplete

public void onEngineJobComplete(Key key,
                       com.bumptech.glide.load.engine.EngineResource<?> resource)

onEngineJobCancelled

public void onEngineJobCancelled(com.bumptech.glide.load.engine.EngineJob engineJob,
                        Key key)

onResourceRemoved

public void onResourceRemoved(Resource<?> resource)

Specified by:

onResourceRemoved in interface MemoryCache.ResourceRemovedListener

onResourceReleased

public void onResourceReleased(Key cacheKey,
                      com.bumptech.glide.load.engine.EngineResource resource)

clearDiskCache

public void clearDiskCache()