download/org.fdroid.download

Package-level declarations

Types

abstract class Downloader(indexFile: IndexFile, outputFile: File)

DownloadRequest

data class DownloadRequest @JvmOverloads constructor(val indexFile: IndexFile, val mirrors: List<Mirror>, val proxy: ProxyConfig? = null, val username: String? = null, val password: String? = null, val tryFirstMirror: Mirror? = null)

data class DownloadRequest constructor(val indexFile: IndexFile, val mirrors: List<Mirror>, val proxy: <Error class: unknown class>? = null, val username: String? = null, val password: String? = null, val tryFirstMirror: Mirror? = null)

HeadInfo

data class HeadInfo(val eTagChanged: Boolean, val eTag: String?, val contentLength: Long?, val lastModified: String?)

HttpDownloader

class ~~HttpDownloader~~(httpManager: HttpManager, request: DownloadRequest, destFile: File) : Downloader

Download files over HTTP, with support for proxies, .onion addresses, HTTP Basic Auth, etc.

HttpDownloaderV2

class HttpDownloaderV2(httpManager: HttpManager, request: DownloadRequest, destFile: File) : Downloader

Download files over HTTP, with support for proxies, .onion addresses, HTTP Basic Auth, etc.

HttpManager

open class HttpManager @JvmOverloads constructor(userAgent: String, queryString: String? = null, proxyConfig: ProxyConfig? = null, customDns: Dns? = null, highTimeouts: Boolean = false, mirrorChooser: MirrorChooser = MirrorChooserRandom(), httpClientEngineFactory: HttpClientEngineFactory<*> = getHttpClientEngineFactory( customDns ))

open class HttpManager constructor(userAgent: String, queryString: String? = null, proxyConfig: <Error class: unknown class>? = null, customDns: <Error class: unknown class>? = null, highTimeouts: Boolean = false, mirrorChooser: MirrorChooser = MirrorChooserRandom(), httpClientEngineFactory: <Error class: unknown class><out <Error class: unknown class>> = getHttpClientEngineFactory( customDns ))

HttpPoster

class HttpPoster(httpManager: HttpManager, url: String)

HTTP POST a JSON string to the URL configured in the constructor.

Mirror

data class Mirror @JvmOverloads constructor(val baseUrl: String, val location: String? = null, val isIpfsGateway: Boolean = false)

data class Mirror constructor(val baseUrl: String, val location: String? = null, val isIpfsGateway: Boolean = false)

MirrorChooser

interface MirrorChooser

NoResumeException

class NoResumeException : Exception

Thrown if we tried to resume a download, but the current mirror server does not offer resuming.

class NoResumeException

Thrown if we tried to resume a download, but the current mirror server does not offer resuming.

NotFoundException

class NotFoundException(e: Throwable? = null) : Exception

Thrown when a file was not found. Catching this is useful when checking if a new index version exists and then falling back to an older version.

class NotFoundException(e: Throwable? = null)

Thrown when a file was not found. Catching this is useful when checking if a new index version exists and then falling back to an older version.

Functions

getDigestInputStream

suspend fun HttpManager.getDigestInputStream(request: DownloadRequest): DigestInputStream

Gets the InputStream for the given request as a DigestInputStream, so you can verify the SHA-256 hash. If you don't need to verify the hash, use getInputStream instead.

getInputStream

suspend fun HttpManager.getInputStream(request: DownloadRequest): InputStream