com.bumptech.glide.integration.okhttp3

Class OkHttpStreamFetcher

java.lang.Object

com.bumptech.glide.integration.okhttp3.OkHttpStreamFetcher

All Implemented Interfaces:

DataFetcher<InputStream>, Callback

public class OkHttpStreamFetcher
extends Object
implements DataFetcher<InputStream>, Callback

Fetches an InputStream using the okhttp library.

Nested Class Summary

Nested classes/interfaces inherited from interface com.bumptech.glide.load.data.DataFetcher

DataFetcher.DataCallback<T>

Constructor Summary

Constructors

Constructor and Description
OkHttpStreamFetcher(Call.Factory client, GlideUrl url)

Method Summary

Modifier and Type	Method and Description
void	cancel() A method that will be called when a load is no longer relevant and has been cancelled.
void	cleanup() Cleanup or recycle any resources used by this data fetcher.
Class<InputStream>	getDataClass() Returns the class of the data this fetcher will attempt to obtain.
DataSource	getDataSource() Returns the DataSource this fetcher will return data from.
void	loadData(Priority priority, DataFetcher.DataCallback<? super InputStream> callback) Fetch data from which a resource can be decoded.
void	onFailure(Call call, IOException e)
void	onResponse(Call call, Response response)

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpStreamFetcher

public OkHttpStreamFetcher(Call.Factory client,
                           GlideUrl url)

Method Detail

loadData

public void loadData(Priority priority,
                     DataFetcher.DataCallback<? super InputStream> callback)

Description copied from interface: DataFetcher

Fetch data from which a resource can be decoded.

This will always be called on background thread so it is safe to perform long running tasks here. Any third party libraries called must be thread safe (or move the work to another thread) since this method will be called from a thread in a ExecutorService that may have more than one background thread.

You MUST use the DataFetcher.DataCallback once the request is complete. You are free to move the fetch work to another thread and call the callback from there.

This method will only be called when the corresponding resource is not in the cache.

Note - this method will be run on a background thread so blocking I/O is safe.

Specified by:

loadData in interface DataFetcher<InputStream>

Parameters:

priority - The priority with which the request should be completed.

callback - The callback to use when the request is complete

See Also:

where the data retuned will be cleaned up

onFailure

public void onFailure(@NonNull
                      Call call,
                      @NonNull
                      IOException e)

Specified by:

onFailure in interface Callback

onResponse

public void onResponse(@NonNull
                       Call call,
                       @NonNull
                       Response response)
                throws IOException

Specified by:

onResponse in interface Callback

Throws:

IOException

cleanup

public void cleanup()

Description copied from interface: DataFetcher

Cleanup or recycle any resources used by this data fetcher. This method will be called in a finally block after the data provided by DataFetcher.loadData(com.bumptech.glide.Priority, com.bumptech.glide.load.data.DataFetcher.DataCallback) has been decoded by the ResourceDecoder.

Note - this method will be run on a background thread so blocking I/O is safe.

Specified by:

cleanup in interface DataFetcher<InputStream>

cancel

public void cancel()

Description copied from interface: DataFetcher

A method that will be called when a load is no longer relevant and has been cancelled. This method does not need to guarantee that any in process loads do not finish. It also may be called before a load starts or after it finishes.

The best way to use this method is to cancel any loads that have not yet started, but allow those that are in process to finish since its we typically will want to display the same resource in a different view in the near future.

Note - this method will be run on the main thread so it should not perform blocking operations and should finish quickly.

Specified by:

cancel in interface DataFetcher<InputStream>

getDataClass

@NonNull
public Class<InputStream> getDataClass()

Description copied from interface: DataFetcher

Returns the class of the data this fetcher will attempt to obtain.

Specified by:

getDataClass in interface DataFetcher<InputStream>

getDataSource

@NonNull
public DataSource getDataSource()

Description copied from interface: DataFetcher

Returns the DataSource this fetcher will return data from.

Specified by:

getDataSource in interface DataFetcher<InputStream>