You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/Endpoint/ContainerArchiveInfo.php
+3-1Lines changed: 3 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ class ContainerArchiveInfo extends \Docker\API\Runtime\Client\BaseEndpoint imple
9
9
protected$id;
10
10
11
11
/**
12
-
* A response header `X-Docker-Container-Path-Stat` is return containing a base64 - encoded JSON object with some filesystem header information about the path.
12
+
* A response header `X-Docker-Container-Path-Stat` is returned, containing.
13
+
* a base64 - encoded JSON object with some filesystem header information
Copy file name to clipboardExpand all lines: src/Endpoint/ContainerAttach.php
+33-14Lines changed: 33 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,20 @@ class ContainerAttach extends \Docker\API\Runtime\Client\BaseEndpoint implements
9
9
protected$id;
10
10
11
11
/**
12
-
* Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached.
12
+
* Attach to a container to read its output or send it input. You can attach.
13
+
* to the same container multiple times and you can reattach to containers
14
+
* that have been detached.
13
15
*
14
-
* Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything.
16
+
* Either the `stream` or `logs` parameter must be `true` for this endpoint
17
+
* to do anything.
15
18
*
16
-
* See [the documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details.
19
+
* See the [documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/)
20
+
* for more details.
17
21
*
18
22
* ### Hijacking
19
23
*
20
-
* This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and `stderr` on the same socket.
24
+
* This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,
25
+
* and `stderr` on the same socket.
21
26
*
22
27
* This is the response from the daemon for an attach request:
23
28
*
@@ -28,9 +33,11 @@ class ContainerAttach extends \Docker\API\Runtime\Client\BaseEndpoint implements
28
33
* [STREAM]
29
34
* ```
30
35
*
31
-
* After the headers and two new lines, the TCP connection can now be used for raw, bidirectional communication between the client and server.
36
+
* After the headers and two new lines, the TCP connection can now be used
37
+
* for raw, bidirectional communication between the client and server.
32
38
*
33
-
* To hint potential proxies about connection hijacking, the Docker client can also optionally send connection upgrade headers.
39
+
* To hint potential proxies about connection hijacking, the Docker client
40
+
* can also optionally send connection upgrade headers.
34
41
*
35
42
* For example, the client sends this request to upgrade the connection:
36
43
*
@@ -40,7 +47,8 @@ class ContainerAttach extends \Docker\API\Runtime\Client\BaseEndpoint implements
40
47
* Connection: Upgrade
41
48
* ```
42
49
*
43
-
* The Docker daemon will respond with a `101 UPGRADED` response, and will similarly follow with the raw stream:
50
+
* The Docker daemon will respond with a `101 UPGRADED` response, and will
51
+
* similarly follow with the raw stream:
44
52
*
45
53
* ```
46
54
* HTTP/1.1 101 UPGRADED
@@ -53,9 +61,14 @@ class ContainerAttach extends \Docker\API\Runtime\Client\BaseEndpoint implements
53
61
*
54
62
* ### Stream format
55
63
*
56
-
* When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate), the stream over the hijacked connected is multiplexed to separate out `stdout` and `stderr`. The stream consists of a series of frames, each containing a header and a payload.
64
+
* When the TTY setting is disabled in [`POST /containers/create`](#operation/ContainerCreate),
65
+
* the stream over the hijacked connected is multiplexed to separate out
66
+
* `stdout` and `stderr`. The stream consists of a series of frames, each
67
+
* containing a header and a payload.
57
68
*
58
-
* The header contains the information which the stream writes (`stdout` or `stderr`). It also contains the size of the associated frame encoded in the last four bytes (`uint32`).
69
+
* The header contains the information which the stream writes (`stdout` or
70
+
* `stderr`). It also contains the size of the associated frame encoded in
71
+
* the last four bytes (`uint32`).
59
72
*
60
73
* It is encoded on the first eight bytes like this:
61
74
*
@@ -69,9 +82,11 @@ class ContainerAttach extends \Docker\API\Runtime\Client\BaseEndpoint implements
69
82
* - 1: `stdout`
70
83
* - 2: `stderr`
71
84
*
72
-
* `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as big endian.
85
+
* `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size
86
+
* encoded as big endian.
73
87
*
74
-
* Following the header is the payload, which is the specified number of bytes of `STREAM_TYPE`.
88
+
* Following the header is the payload, which is the specified number of
89
+
* bytes of `STREAM_TYPE`.
75
90
*
76
91
* The simplest way to implement this protocol is the following:
77
92
*
@@ -83,15 +98,19 @@ class ContainerAttach extends \Docker\API\Runtime\Client\BaseEndpoint implements
83
98
*
84
99
* ### Stream format when using a TTY
85
100
*
86
-
* When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate), the stream is not multiplexed. The data exchanged over the hijacked connection is simply the raw data from the process PTY and client's `stdin`.
101
+
* When the TTY setting is enabled in [`POST /containers/create`](#operation/ContainerCreate),
102
+
* the stream is not multiplexed. The data exchanged over the hijacked
103
+
* connection is simply the raw data from the process PTY and client's
104
+
* `stdin`.
87
105
*
88
106
* @param string $id ID or name of the container
89
107
* @param array $queryParameters {
90
108
*
91
-
* @var string $detachKeys Override the key sequence for detaching a container.Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`.
109
+
* @var string $detachKeys Override the key sequence for detaching a container.Format is a single
92
110
* @var bool $logs Replay previous logs from the container.
93
111
*
94
-
* @var bool $stream Stream attached streams from the time the request was made onwards
112
+
* @var bool $stream Stream attached streams from the time the request was made onwards.
Copy file name to clipboardExpand all lines: src/Endpoint/ContainerAttachWebsocket.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ class ContainerAttachWebsocket extends \Docker\API\Runtime\Client\BaseEndpoint i
12
12
* @param string $id ID or name of the container
13
13
* @param array $queryParameters {
14
14
*
15
-
* @var string $detachKeys Override the key sequence for detaching a container.Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,`, or `_`.
15
+
* @var string $detachKeys Override the key sequence for detaching a container.Format is a single
0 commit comments