readium-shared/org.readium.r2.shared.util.http/DefaultHttpClient

DefaultHttpClient

class DefaultHttpClient(userAgent: String? = null, connectTimeout: Duration? = null, readTimeout: Duration? = null, var callback: DefaultHttpClient.Callback = object : Callback {}) : HttpClient

An implementation of HttpClient using the native HttpURLConnection.

Parameters

userAgent

Custom user agent to use for requests.

connectTimeout

Timeout used when establishing a connection to the resource. A null timeout is interpreted as the default value, while a timeout of zero as an infinite timeout.

readTimeout

Timeout used when reading the input stream. A null timeout is interpreted as the default value, while a timeout of zero as an infinite timeout.

Constructors

DefaultHttpClient

constructor(userAgent: String? = null, connectTimeout: Duration? = null, readTimeout: Duration? = null, callback: DefaultHttpClient.Callback = object : Callback {})

Types

Callback

interface Callback

Callbacks allowing to override some behavior of the DefaultHttpClient.

Companion

object Companion

Properties

callback

var callback: DefaultHttpClient.Callback

Functions

download

suspend fun HttpClient.download(request: HttpRequest, destination: File, onProgress: (Double) -> Unit = {}): Try<HttpResponse, HttpDownloadError>

Downloads the resource from the given request to the destination file.

fetch

suspend fun HttpClient.fetch(request: HttpRequest): HttpTry<HttpFetchResponse>

Fetches the resource from the given request.

fetchJSONObject

suspend fun HttpClient.fetchJSONObject(request: HttpRequest): HttpTry<JSONObject>

Fetches the resource from the given request as a JSONObject.

fetchString

suspend fun HttpClient.fetchString(request: HttpRequest, charset: Charset = Charsets.UTF_8): HttpTry<String>

Fetches the resource from the given request as a String.

fetchWithDecoder

suspend fun <T> HttpClient.fetchWithDecoder(request: HttpRequest, decoder: (HttpFetchResponse) -> T): HttpTry<T>

Fetches the resource from the given request before decoding it with the provided decoder.

head

suspend fun HttpClient.head(request: HttpRequest): HttpTry<HttpResponse>

Performs a HEAD request to retrieve only the response headers.

stream

open suspend override fun stream(request: HttpRequest): HttpTry<HttpStreamResponse>

Streams the resource from the given request.