Skip to content

Commit 3accde6

Browse files
LK4D4LK4D4
committed
attach: replace interface with simple type
Also add docs to detach events Signed-off-by: Alexander Morozov <[email protected]>
1 parent c80a2f2 commit 3accde6

7 files changed

Lines changed: 15 additions & 21 deletions

File tree

‎container/container.go‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,10 @@ var (
4848
errInvalidNetwork = fmt.Errorf("invalid network settings while building port map info")
4949
)
5050

51-
// AttachError represents errors of attach
52-
type AttachError interface {
53-
IsDetached() bool
54-
}
55-
56-
type detachError struct{}
57-
58-
func (e detachError) IsDetached() bool {
59-
return true
60-
}
51+
// DetachError is special error which returned in case of container detach.
52+
type DetachError struct{}
6153

62-
func (e detachError) Error() string {
54+
func (DetachError) Error() string {
6355
return "detached from container"
6456
}
6557

@@ -507,7 +499,7 @@ func copyEscapable(dst io.Writer, src io.ReadCloser, keys []byte) (written int64
507499
}
508500
if i == len(keys)-1 {
509501
src.Close()
510-
return 0, detachError{}
502+
return 0, DetachError{}
511503
}
512504
nr, er = src.Read(buf)
513505
}

‎daemon/attach.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,7 @@ func (daemon *Daemon) containerAttach(c *container.Container, stdin io.ReadClose
121121
}
122122
err := <-c.Attach(stdinPipe, stdout, stderr, keys)
123123
if err != nil {
124-
e, ok := err.(container.AttachError)
125-
if ok && e.IsDetached() {
124+
if _, ok := err.(container.DetachError); ok {
126125
daemon.LogContainerEvent(c, "detach")
127126
} else {
128127
logrus.Errorf("attach failed with error: %v", err)

‎daemon/exec.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,10 @@ func (d *Daemon) ContainerExecStart(ctx context.Context, name string, stdin io.R
222222
return fmt.Errorf("context cancelled")
223223
case err := <-attachErr:
224224
if err != nil {
225-
e, ok := err.(container.AttachError)
226-
if !ok || !e.IsDetached() {
227-
return fmt.Errorf("attach failed with error: %v", err)
225+
if _, ok := err.(container.DetachError); !ok {
226+
return fmt.Errorf("exec attach failed with error: %v", err)
228227
}
229-
d.LogContainerEvent(c, "detach")
228+
d.LogContainerEvent(c, "exec_detach")
230229
}
231230
}
232231
return nil

‎docs/reference/api/docker_remote_api.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Some container-related events are not affected by container state, so they are n
9999
* **export** emitted by `docker export`
100100
* **exec_create** emitted by `docker exec`
101101
* **exec_start** emitted by `docker exec` after **exec_create**
102+
* **detach** emitted when client is detached from container process
103+
* **exec_detach** emitted when client is detached from exec process
102104

103105
Running `docker rmi` emits an **untag** event when removing an image name. The `rmi` command may also emit **delete** events when images are deleted by ID directly or by deleting the last tag referring to the image.
104106

@@ -121,6 +123,8 @@ This section lists each version from latest to oldest. Each listing includes a
121123
* `GET /images/search` now takes a `filters` query parameter.
122124
* `GET /events` now supports a `reload` event that is emitted when the daemon configuration is reloaded.
123125
* `GET /events` now supports filtering by daemon name or ID.
126+
* `GET /events` now supports a `detach` event that is emitted on detaching from container process.
127+
* `GET /events` now supports an `exec_detach ` event that is emitted on detaching from exec process.
124128
* `GET /images/json` now supports filters `since` and `before`.
125129
* `POST /containers/(id or name)/start` no longer accepts a `HostConfig`.
126130
* `POST /images/(name)/tag` no longer has a `force` query parameter.

‎docs/reference/api/docker_remote_api_v1.24.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2404,7 +2404,7 @@ Get container events from docker, either in real time via streaming, or via poll
24042404
24052405
Docker containers report the following events:
24062406
2407-
attach, commit, copy, create, destroy, die, exec_create, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
2407+
attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
24082408
24092409
Docker images report the following events:
24102410

‎docs/reference/commandline/events.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ parent = "smn_cli"
2121

2222
Docker containers report the following events:
2323

24-
attach, commit, copy, create, destroy, die, exec_create, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
24+
attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
2525

2626
Docker images report the following events:
2727

‎man/docker-events.1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ information and real-time information.
1818

1919
Docker containers will report the following events:
2020

21-
attach, commit, copy, create, destroy, die, exec_create, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
21+
attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
2222

2323
Docker images report the following events:
2424

0 commit comments

Comments
 (0)