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

Package-level declarations

Types

data class ConnectionDiagnostic(val problem: ConnectionProblem, val message: String, val suggestion: String, val httpStatus: Int? = null)

Actionable connection diagnostic. Classification is best-effort; unknown errors remain ConnectionProblem.UNKNOWN.

ConnectionProblem

enum ConnectionProblem : Enum<ConnectionProblem>

Outcome of a connection probe or classification of a transport failure.

DockerContextException

class DockerContextException : Exception

Safe metadata marker stored in suppressed exceptions; its message contains only context.

DockerFailureStage

enum DockerFailureStage : Enum<DockerFailureStage>

Stage where the SDK observed a failure, not a claim about its root cause.

DockerOperationContext

data class DockerOperationContext(val method: String, val route: String, val apiVersion: String, val stage: DockerFailureStage, val httpStatus: Int? = null)

Safe metadata attached to an SDK exception. SDK-produced contexts omit socket paths, resource identifiers, query parameters, headers, payloads and exception messages. The original exception itself remains sensitive.

DockerResultException

class DockerResultException : IllegalStateException

Failure raised by getOrThrow on a contextual SDK error Result. Remains an IllegalStateException. error and the original cause are retained for trusted debugging; the message contains only safe context.

Properties

dockerContext

val Throwable.dockerContext: DockerOperationContext?

Context attached by the SDK, including through coroutine-recovered cause chains, or null when absent. Read this instead of printing the original exception when producing user-facing diagnostics. Cancellation and failures outside SDK boundaries may have no context.

Functions

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.

diagnoseFailure

fun DockerClient.diagnoseFailure(failure: Throwable): ConnectionDiagnostic

Describes an upstream transport exception without retrying or modifying it. Use for failures from HTTP calls, stream collection or exec/attach. Do not use to label application callback errors. Recognizes common exception names and OS messages/codes; unsupported/localized messages remain UNKNOWN. Cancellation is rethrown. Clean stream EOF has no exception and requires application-owned reconciliation.