kotlin-components-docs/mozilla.appservices.viaduct

Package-level declarations

Types

Backend

interface Backend

BackendImpl

open class BackendImpl : Disposable, AutoCloseable, Backend

ClientSettings

data class ClientSettings(var timeout: UInt, var redirectLimit: UInt, var ohttpChannel: String?)

Disposable

interface Disposable

FfiConverterTypeHeaders

typealias FfiConverterTypeHeaders = FfiConverterMapStringString

FfiConverterTypeViaductUrl

typealias FfiConverterTypeViaductUrl = FfiConverterString

Headers

typealias Headers = Map<String, String>

Typealias from the type name used in the UDL file to the builtin type. This is needed because the UDL type name is used in function/method signatures. It's also what we have an external type that references a custom type.

InternalException

class InternalException(message: String) : Exception

Method

enum Method : Enum<Method>

HTTP Methods.

OhttpConfig

data class OhttpConfig(var relayUrl: String, var gatewayHost: String)

Configuration for an OHTTP channel

Request

data class Request(var method: Method, var url: ViaductUrl, var headers: Headers, var body: ByteArray?)

Response

data class Response(var requestMethod: Method, var url: ViaductUrl, var status: UShort, var headers: Headers, var body: ByteArray)

A response from the server.

ViaductException

sealed class ViaductException : Exception

ViaductUrl

typealias ViaductUrl = String

Functions

allowAndroidEmulatorLoopback

fun allowAndroidEmulatorLoopback()

Allow non-HTTPS requests to the emulator loopback URL

clearOhttpChannels

fun clearOhttpChannels()

Clear all OHTTP channel configurations

configureDefaultOhttpChannels

fun configureDefaultOhttpChannels()

Configure default OHTTP channels for common Mozilla services This sets up:

configureOhttpChannel

fun configureOhttpChannel(channel: String, config: OhttpConfig)

Configure an OHTTP channel with the given configuration If an existing OHTTP config exists with the same name, it will be overwritten

initBackend

fun initBackend(backend: Backend)

listOhttpChannels

fun listOhttpChannels(): List<String>

List all configured OHTTP channels

uniffiForeignFutureHandleCount

fun uniffiForeignFutureHandleCount(): <Error class: unknown class>