ktor-client-utils/com.pambrose.common.dsl/KtorDsl

KtorDsl

A DSL object providing factory methods and utilities for Ktor HttpClient operations.

Supports suspending HTTP request patterns with automatic client lifecycle management; a blocking variant is available on the JVM as the blockingGet extension.

Functions

blockingGet

fun <T> KtorDsl.blockingGet(url: String, setUp: HttpRequestBuilder.() -> Unit = {}, block: suspend (HttpResponse) -> T): T

Performs a blocking HTTP GET request using a temporary io.ktor.client.HttpClient.

get

suspend fun <T> HttpClient.get(url: String, setUp: HttpRequestBuilder.() -> Unit = {}, block: suspend (HttpResponse) -> T): T

Performs an HTTP GET request on this HttpClient and passes the response to block.

httpClient

suspend fun <T> httpClient(httpClient: HttpClient? = null, expectSuccess: Boolean = false, block: suspend (HttpClient) -> T): T

Executes block with an HttpClient passed as a parameter. If httpClient is null, a new client is created and automatically closed after the block completes.

newHttpClient

fun newHttpClient(expectSuccess: Boolean = false): HttpClient

Creates a new HttpClient configured with HttpTimeout support.

withHttpClient

suspend fun <T> withHttpClient(httpClient: HttpClient? = null, expectSuccess: Boolean = false, block: suspend HttpClient.() -> T): T

Executes block with an HttpClient as the receiver. If httpClient is null, a new client is created and automatically closed after the block completes.