Skip to content

Docker attach via WebSocket support #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devnatan wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Docker attach via WebSocket support #241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4cfebe5
Create `isMultiplexedStream` support function
devnatan Jan 20, 2026
825e33d
Write tests for `isMultiplexedStream` and `readPayloadSize`
devnatan Jan 20, 2026
be77a2a
ContainerAttachOptions
devnatan Jan 20, 2026
d4a1a7c
ContainerAttachWebSocketResult
devnatan Jan 20, 2026
cd28311
Install WebSockets plugin
devnatan Jan 20, 2026
1d7bc70
ContainerResource `attachWebSocket`
devnatan Jan 20, 2026
72825fa
Write integration tests
devnatan Jan 20, 2026
9294eb2
Update SUPPORTED_ENDPOINTS.md
devnatan Jan 20, 2026
9e359a1
Update legacy ABI
devnatan Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions SUPPORTED_ENDPOINTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# docker-kotlin supported Docker API endpoints

Supports 48 of 106 endpoints
Supports 49 of 107 endpoints

### Containers (15/25)
### Containers (16/26)
* [x] List containers - GET **/containers/json**
* [x] Create a container - POST **/containers/create**
* [x] Inspect a container - GET **/containers/:id/json**
Expand All @@ -20,8 +20,9 @@ Supports 48 of 106 endpoints
* [x] Rename a container - **POST /containers/:id/rename**
* [x] Pause a container - **POST /containers/:id/pause**
* [x] Unpause a container - **POST /containers/:id/unpause**
* [ ] Attach to a container - **POST /containers/:id/attach**
* [ ] Attach to a container via a websocket - **POST /containers/:id/attach/ws**
* [ ] Attach to a container (HTTP) - **POST /containers/:id/attach**
* [ ] Attach to a container (TCP) - **POST /containers/:id/attach**
* [x] Attach to a container (WebSocket) - **POST /containers/:id/attach/ws**
* [x] Wait for a container - **POST /containers/:id/wait**
* [x] Remove a container - **DELETE /containers/:id**
* [x] Get information about files in a container - **HEAD /containers/:id/archive**
Expand Down
88 changes: 88 additions & 0 deletions api/docker-kotlin.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1345,6 +1345,91 @@ public final class me/devnatan/dockerkt/models/container/ContainerArchiveInfoKt
public static final fun getModifiedAt (Lme/devnatan/dockerkt/models/container/ContainerArchiveInfo;)Lkotlin/time/Instant;
}

public final class me/devnatan/dockerkt/models/container/ContainerAttachOptions {
public static final field Companion Lme/devnatan/dockerkt/models/container/ContainerAttachOptions$Companion;
public fun <init> ()V
public fun <init> (ZZZZZLjava/lang/String;)V
public synthetic fun <init> (ZZZZZLjava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun component1 ()Z
public final fun component2 ()Z
public final fun component3 ()Z
public final fun component4 ()Z
public final fun component5 ()Z
public final fun component6 ()Ljava/lang/String;
public final fun copy (ZZZZZLjava/lang/String;)Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;
public static synthetic fun copy$default (Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;ZZZZZLjava/lang/String;ILjava/lang/Object;)Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;
public fun equals (Ljava/lang/Object;)Z
public final fun getDetachKeys ()Ljava/lang/String;
public final fun getLogs ()Z
public final fun getStderr ()Z
public final fun getStdin ()Z
public final fun getStdout ()Z
public final fun getStream ()Z
public fun hashCode ()I
public final fun setDetachKeys (Ljava/lang/String;)V
public final fun setLogs (Z)V
public final fun setStderr (Z)V
public final fun setStdin (Z)V
public final fun setStdout (Z)V
public final fun setStream (Z)V
public fun toString ()Ljava/lang/String;
}

public final synthetic class me/devnatan/dockerkt/models/container/ContainerAttachOptions$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lme/devnatan/dockerkt/models/container/ContainerAttachOptions$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class me/devnatan/dockerkt/models/container/ContainerAttachOptions$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public abstract class me/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult {
public abstract fun getClose ()Lkotlin/jvm/functions/Function1;
}

public final class me/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$Connected : me/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult {
public fun <init> (Lkotlin/jvm/functions/Function1;Lkotlinx/coroutines/flow/Flow;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;)V
public final fun component1 ()Lkotlin/jvm/functions/Function1;
public final fun component2 ()Lkotlinx/coroutines/flow/Flow;
public final fun component3 ()Lkotlin/jvm/functions/Function2;
public final fun component4 ()Lkotlin/jvm/functions/Function2;
public final fun copy (Lkotlin/jvm/functions/Function1;Lkotlinx/coroutines/flow/Flow;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;)Lme/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$Connected;
public static synthetic fun copy$default (Lme/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$Connected;Lkotlin/jvm/functions/Function1;Lkotlinx/coroutines/flow/Flow;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)Lme/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$Connected;
public fun equals (Ljava/lang/Object;)Z
public fun getClose ()Lkotlin/jvm/functions/Function1;
public final fun getOutput ()Lkotlinx/coroutines/flow/Flow;
public final fun getSendBinary ()Lkotlin/jvm/functions/Function2;
public final fun getSendText ()Lkotlin/jvm/functions/Function2;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class me/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$ConnectedDemuxed : me/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult {
public fun <init> (Lkotlin/jvm/functions/Function1;Lkotlinx/coroutines/flow/Flow;Lkotlinx/coroutines/flow/Flow;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;)V
public final fun component1 ()Lkotlin/jvm/functions/Function1;
public final fun component2 ()Lkotlinx/coroutines/flow/Flow;
public final fun component3 ()Lkotlinx/coroutines/flow/Flow;
public final fun component4 ()Lkotlin/jvm/functions/Function2;
public final fun component5 ()Lkotlin/jvm/functions/Function2;
public final fun copy (Lkotlin/jvm/functions/Function1;Lkotlinx/coroutines/flow/Flow;Lkotlinx/coroutines/flow/Flow;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;)Lme/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$ConnectedDemuxed;
public static synthetic fun copy$default (Lme/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$ConnectedDemuxed;Lkotlin/jvm/functions/Function1;Lkotlinx/coroutines/flow/Flow;Lkotlinx/coroutines/flow/Flow;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)Lme/devnatan/dockerkt/models/container/ContainerAttachWebSocketResult$ConnectedDemuxed;
public fun equals (Ljava/lang/Object;)Z
public fun getClose ()Lkotlin/jvm/functions/Function1;
public final fun getSendBinary ()Lkotlin/jvm/functions/Function2;
public final fun getSendText ()Lkotlin/jvm/functions/Function2;
public final fun getStderr ()Lkotlinx/coroutines/flow/Flow;
public final fun getStdout ()Lkotlinx/coroutines/flow/Flow;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class me/devnatan/dockerkt/models/container/ContainerConfig {
public static final field Companion Lme/devnatan/dockerkt/models/container/ContainerConfig$Companion;
public fun <init> ()V
Expand Down Expand Up @@ -5016,6 +5101,8 @@ public final class me/devnatan/dockerkt/resource/container/ContainerRenameConfli
public final class me/devnatan/dockerkt/resource/container/ContainerResource {
public fun <init> (Lkotlinx/coroutines/CoroutineScope;Lkotlinx/serialization/json/Json;Lio/ktor/client/HttpClient;)V
public final synthetic fun attach (Ljava/lang/String;)Lkotlinx/coroutines/flow/Flow;
public final fun attachWebSocket (Ljava/lang/String;Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static synthetic fun attachWebSocket$default (Lme/devnatan/dockerkt/resource/container/ContainerResource;Ljava/lang/String;Lme/devnatan/dockerkt/models/container/ContainerAttachOptions;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
public final fun copyDirectoryFrom (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun copyDirectoryTo (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lme/devnatan/dockerkt/models/container/ContainerCopyOptions;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static synthetic fun copyDirectoryTo$default (Lme/devnatan/dockerkt/resource/container/ContainerResource;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lme/devnatan/dockerkt/models/container/ContainerCopyOptions;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
Expand Down Expand Up @@ -5086,6 +5173,7 @@ public final class me/devnatan/dockerkt/resource/container/ContainerResource {
}

public final class me/devnatan/dockerkt/resource/container/ContainerResourceExtKt {
public static final fun attachWebSocket (Lme/devnatan/dockerkt/resource/container/ContainerResource;Ljava/lang/String;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun copyDirectoryTo (Lme/devnatan/dockerkt/resource/container/ContainerResource;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun copyFileTo (Lme/devnatan/dockerkt/resource/container/ContainerResource;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun copyTo (Lme/devnatan/dockerkt/resource/container/ContainerResource;Ljava/lang/String;Ljava/lang/String;[BLkotlin/jvm/functions/Function1;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand Down
Loading
Loading