Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.diagnostics/diagnoseConnection

diagnoseConnection

suspend fun DockerClient.diagnoseConnection(timeoutMillis: Long): ConnectionDiagnostic

Probes the configured daemon using the SDK's versioned ping without changing daemon state. A successful probe establishes reachability/API acceptance, not permission for every Docker operation. Does not retry or close this client. Cancellation from the caller always propagates.

Return

Diagnostic with a category and actionable guidance; raw transport details are deliberately omitted.

Parameters

timeoutMillis

Positive HTTP request/connect/socket timeout for this probe only.

Throws

IllegalArgumentException

If timeoutMillis is not positive.

Samples

val report = docker.diagnoseConnection(timeoutMillis = 5_000)
println("${report.problem}: ${report.message}")
println(report.suggestion)