iframe-proxy | Sunbelt Computer Software

176 lines (134 loc) · 6.6 KB
declare(strict_types=1);
 * This file has been auto generated by Jane,
 * Do no edit it directly.
namespace Docker\API\Endpoint;
class ContainerAttach extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\AmpArtaxEndpoint, \Jane\OpenApiRuntime\Client\Psr7HttplugEndpoint
    protected $id;
     * 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.
    Either the `stream` or `logs` parameter must be `true` for this endpoint to do anything.
    See [the documentation for the `docker attach` command](https://docs.docker.com/engine/reference/commandline/attach/) for more details.
    ### Hijacking
    This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`, and `stderr` on the same socket.
    This is the response from the daemon for an attach request:
    HTTP/1.1 200 OK
    Content-Type: application/vnd.docker.raw-stream
    [STREAM]
    After the headers and two new lines, the TCP connection can now be used for raw, bidirectional communication between the client and server.
    To hint potential proxies about connection hijacking, the Docker client can also optionally send connection upgrade headers.
    For example, the client sends this request to upgrade the connection:
    POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1
    Upgrade: tcp
    Connection: Upgrade
    The Docker daemon will respond with a `101 UPGRADED` response, and will similarly follow with the raw stream:
    HTTP/1.1 101 UPGRADED
    Content-Type: application/vnd.docker.raw-stream
    Connection: Upgrade
    Upgrade: tcp
    [STREAM]
    ### Stream format
    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.
    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`).
    It is encoded on the first eight bytes like this:
    header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
    `STREAM_TYPE` can be:
    - 0: `stdin` (is written on `stdout`)
    - 1: `stdout`
    - 2: `stderr`
    `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size encoded as big endian.
    Following the header is the payload, which is the specified number of bytes of `STREAM_TYPE`.
    The simplest way to implement this protocol is the following:
    1. Read 8 bytes.
    2. Choose `stdout` or `stderr` depending on the first byte.
    3. Extract the frame size from the last four bytes.
    4. Read the extracted size and output it on the correct output.
    5. Goto 1.
    ### Stream format when using a TTY
    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`.
     * @param string $id              ID or name of the container
     * @param array  $queryParameters {
     *     @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 `_`.
     *     @var bool $logs replay previous logs from the container
     *     @var bool $stream Stream attached streams from the the time the request was made onwards
     *     @var bool $stdin Attach to `stdin`
     *     @var bool $stdout Attach to `stdout`
     *     @var bool $stderr Attach to `stderr`
    public function __construct(string $id, array $queryParameters = [])
        $this->id = $id;
        $this->queryParameters = $queryParameters;
    use \Jane\OpenApiRuntime\Client\AmpArtaxEndpointTrait, \Jane\OpenApiRuntime\Client\Psr7HttplugEndpointTrait;
    public function getMethod(): string
        return 'POST';
    public function getUri(): string
        return str_replace(['{id}'], [$this->id], '/containers/{id}/attach');
    public function getBody(\Symfony\Component\Serializer\SerializerInterface $serializer, \Http\Message\StreamFactory $streamFactory = null): array
        return [[], null];
    public function getExtraHeaders(): array
        return ['Accept' => ['application/json']];
    protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
        $optionsResolver = parent::getQueryOptionsResolver();
        $optionsResolver->setDefined(['detachKeys', 'logs', 'stream', 'stdin', 'stdout', 'stderr']);
        $optionsResolver->setRequired([]);
        $optionsResolver->setDefaults(['logs' => false, 'stream' => false, 'stdin' => false, 'stdout' => false, 'stderr' => false]);
        $optionsResolver->setAllowedTypes('detachKeys', ['string']);
        $optionsResolver->setAllowedTypes('logs', ['bool']);
        $optionsResolver->setAllowedTypes('stream', ['bool']);
        $optionsResolver->setAllowedTypes('stdin', ['bool']);
        $optionsResolver->setAllowedTypes('stdout', ['bool']);
        $optionsResolver->setAllowedTypes('stderr', ['bool']);
        return $optionsResolver;
     * {@inheritdoc}
     * @throws \Docker\API\Exception\ContainerAttachBadRequestException
     * @throws \Docker\API\Exception\ContainerAttachNotFoundException
     * @throws \Docker\API\Exception\ContainerAttachInternalServerErrorException
    protected function transformResponseBody(string $body, int $status, \Symfony\Component\Serializer\SerializerInterface $serializer)
        if (101 === $status) {
            return null;
        if (200 === $status) {
            return null;
        if (400 === $status) {
            throw new \Docker\API\Exception\ContainerAttachBadRequestException($serializer->deserialize($body, 'Docker\\API\\Model\\ErrorResponse', 'json'));
        if (404 === $status) {
            throw new \Docker\API\Exception\ContainerAttachNotFoundException($serializer->deserialize($body, 'Docker\\API\\Model\\ErrorResponse', 'json'));
        if (500 === $status) {
            throw new \Docker\API\Exception\ContainerAttachInternalServerErrorException($serializer->deserialize($body, 'Docker\\API\\Model\\ErrorResponse', 'json'));
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

ContainerAttach.php

Latest commit

History

ContainerAttach.php

File metadata and controls
