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

Package-level declarations

Types

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.

HttpClient

interface HttpClient

An HTTP client performs HTTP requests.

HttpContainer

class HttpContainer(baseUrl: Url? = null, val entries: Set<Url>, client: HttpClient) : Container<Resource>

Fetches remote resources through HTTP.

HttpDownloadError

sealed class HttpDownloadError : Error

Represents an error occurring during an HTTP download activity.

HttpError

sealed class HttpError : AccessError

Represents an error occurring during an HTTP activity.

HttpFetchResponse

class HttpFetchResponse(val response: HttpResponse, val body: ByteArray)

HTTP response with the whole body as a ByteArray.

HttpHeaders

data class HttpHeaders(val headers: Map<String, List<String>>)

Helper to parse HTTP request/response headers.

HttpRange

data class HttpRange(val start: Long, val end: Long?)

HTTP content range.

HttpRequest

class HttpRequest(val url: AbsoluteUrl, val method: HttpRequest.Method = Method.GET, val headers: Map<String, List<String>> = mapOf(), val body: HttpRequest.Body? = null, val extras: Bundle = Bundle(), val connectTimeout: Duration? = null, val readTimeout: Duration? = null, val allowUserInteraction: Boolean = false) : Serializable

Holds the information about an HTTP request performed by an HttpClient.

HttpResource

class HttpResource(val sourceUrl: AbsoluteUrl, client: HttpClient, maxSkipBytes: Long = MAX_SKIP_BYTES) : Resource

Provides access to an external URL through HTTP.

HttpResourceFactory

class HttpResourceFactory(httpClient: HttpClient) : ResourceFactory

Creates HttpResource instances granting access to http:// URLs using an HttpClient.

HttpResponse

data class HttpResponse(val request: HttpRequest, val url: AbsoluteUrl, val statusCode: HttpStatus, val headers: Map<String, List<String>>, val mediaType: MediaType?)

Represents a successful HTTP response received from a server.

HttpStatus

@JvmInline

value class HttpStatus(val code: Int) : Comparable<HttpStatus>

Status code of an HTTP response.

HttpStreamResponse

class HttpStreamResponse(val response: HttpResponse, val body: InputStream)

HTTP response with streamable content.

HttpTry

typealias HttpTry<SuccessT> = Try<SuccessT, HttpError>

ProblemDetails

data class ProblemDetails(val title: String, val type: String? = null, val status: Int? = null, val detail: String? = null, val instance: String? = null) : Parcelable

Problem Details for HTTP APIs.

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.