com.atakmap.android.http.rest

Class DownloadProgressTracker

java.lang.Object

com.atakmap.android.http.rest.DownloadProgressTracker

public class DownloadProgressTracker
extends java.lang.Object

Track ongoing download progress including percentage, smoothed average throughput, and estimated time remaining Assume that invokers periodically notify the user somehow, which starts a new "block" for tracking purposes

Constructor Summary

Constructors

Constructor and Description
DownloadProgressTracker(double totalLength) ctor

Method Summary

Modifier and Type	Method and Description
boolean	contentReceived(int len, long currentTime) Update internal state for amount of data received If conditions are met for starting a new block, then additional internal state is updated
boolean	contentReceived(long totalBytesSoFar, long totalLen, long currentTime)
void	error() Upon error, clear progress flag (e.g.
double	getAverageSpeed() Bytes per Millisecond
long	getCurrentLength()
int	getCurrentProgress() Percentage
long	getTimeRemaining() Milliseconds (estimated)
boolean	isProgressMade()
void	notified(long currentTime) User has been notified, finish updating internal state to start new block
void	setCurrentLength(long length)

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadProgressTracker

public DownloadProgressTracker(double totalLength)

ctor

Parameters:

totalLength -

Method Detail

contentReceived

public boolean contentReceived(long totalBytesSoFar,
                               long totalLen,
                               long currentTime)

Returns:

true if we should update/notify user

contentReceived

public boolean contentReceived(int len,
                               long currentTime)

Update internal state for amount of data received If conditions are met for starting a new block, then additional internal state is updated

Parameters:

len -

currentTime -

Returns:

true if we should update/notify user

notified

public void notified(long currentTime)

User has been notified, finish updating internal state to start new block

Parameters:

currentTime -

isProgressMade

public boolean isProgressMade()

error

public void error()

Upon error, clear progress flag (e.g. retry counter should not restart)

getCurrentProgress

public int getCurrentProgress()

Percentage

Returns:

getAverageSpeed

public double getAverageSpeed()

Bytes per Millisecond

Returns:

getTimeRemaining

public long getTimeRemaining()

Milliseconds (estimated)

Returns:

setCurrentLength

public void setCurrentLength(long length)

getCurrentLength

public long getCurrentLength()