client/container_attach.go
4f0d95fa
 package client // import "github.com/docker/docker/client"
7c36a1af
 
 import (
7d62e40f
 	"context"
7c36a1af
 	"net/url"
 
 	"github.com/docker/docker/api/types"
 )
 
 // ContainerAttach attaches a connection to a container in the server.
 // It returns a types.HijackedConnection with the hijacked connection
 // and the a reader to get output. It's up to the called to close
 // the hijacked connection by calling types.HijackedResponse.Close.
48829ddf
 //
 // The stream format on the response will be in one of two formats:
 //
 // If the container is using a TTY, there is only a single stream (stdout), and
 // data is copied directly from the container output stream, no extra
 // multiplexing or headers.
 //
 // If the container is *not* using a TTY, streams for stdout and stderr are
 // multiplexed.
 // The format of the multiplexed stream is as follows:
 //
 //    [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}[]byte{OUTPUT}
 //
 // STREAM_TYPE can be 1 for stdout and 2 for stderr
 //
 // SIZE1, SIZE2, SIZE3, and SIZE4 are four bytes of uint32 encoded as big endian.
 // This is the size of OUTPUT.
 //
 // You can use github.com/docker/docker/pkg/stdcopy.StdCopy to demultiplex this
 // stream.
7c36a1af
 func (cli *Client) ContainerAttach(ctx context.Context, container string, options types.ContainerAttachOptions) (types.HijackedResponse, error) {
 	query := url.Values{}
 	if options.Stream {
 		query.Set("stream", "1")
 	}
 	if options.Stdin {
 		query.Set("stdin", "1")
 	}
 	if options.Stdout {
 		query.Set("stdout", "1")
 	}
 	if options.Stderr {
 		query.Set("stderr", "1")
 	}
 	if options.DetachKeys != "" {
 		query.Set("detachKeys", options.DetachKeys)
 	}
fc8097f9
 	if options.Logs {
 		query.Set("logs", "1")
 	}
7c36a1af
 
 	headers := map[string][]string{"Content-Type": {"text/plain"}}
 	return cli.postHijacked(ctx, "/containers/"+container+"/attach", query, nil, headers)
 }