Created
January 7, 2019 09:55
-
-
Save Syex/759be579129710a9065a150e9d2f1d48 to your computer and use it in GitHub Desktop.
An OkHttp ResponseBody to observe download progress. It's the sample migrated to Kotlin: https://github.com/square/okhttp/blob/master/samples/guide/src/main/java/okhttp3/recipes/Progress.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
private const val EXHAUSTED_SOURCE = -1L | |
/** | |
* A [ResponseBody] that informs a [ProgressListener] about the download progress. | |
*/ | |
class DownloadProgressBody( | |
private val responseBody: ResponseBody, | |
private val progressListener: ProgressListener | |
) : ResponseBody() { | |
private var bufferedSource: BufferedSource? = null | |
override fun contentType(): MediaType? = responseBody.contentType() | |
override fun contentLength(): Long = responseBody.contentLength() | |
override fun source(): BufferedSource? { | |
if (bufferedSource == null) { | |
bufferedSource = Okio.buffer(source(responseBody.source())) | |
} | |
return bufferedSource | |
} | |
private fun source(source: Source): Source { | |
return object : ForwardingSource(source) { | |
var totalBytesRead = 0L | |
override fun read(sink: Buffer, byteCount: Long): Long { | |
val bytesRead = super.read(sink, byteCount) | |
// read() returns the number of bytes read, or -1 if this source is exhausted. | |
totalBytesRead += if (bytesRead != EXHAUSTED_SOURCE) bytesRead else 0L | |
progressListener.update(totalBytesRead, responseBody.contentLength(), bytesRead == EXHAUSTED_SOURCE) | |
return bytesRead | |
} | |
} | |
} | |
} | |
/** | |
* Callback getting informed when the download progress of [DownloadProgressBody] updates. | |
*/ | |
interface ProgressListener { | |
/** | |
* Informs this listener that the download progress was updated. | |
* | |
* @param bytesRead The bytes that have been read. | |
* @param contentLength The total bytes that are being read. | |
* @param done Whether the download is complete. | |
*/ | |
fun update(bytesRead: Long, contentLength: Long, done: Boolean) | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment