shell

Documentation

Index

• func MonitorTtySize(ctx context.Context, client *client.Client, out *OutStream, id string, ...) error
• type CommonStream
  • func (s *CommonStream) FD() uintptr
  • func (s *CommonStream) IsTerminal() bool
  • func (s *CommonStream) RestoreTerminal()
  • func (s *CommonStream) SetIsTerminal(isTerminal bool)
  • func (s *CommonStream) SetRawMode()
• type InStream
  • func NewInStream(in io.ReadCloser) *InStream
  • func (i *InStream) Close() error
  • func (i *InStream) IsTty() bool
  • func (i *InStream) Read(p []byte) (int, error)
• type OutStream
  • func NewOutStream(out io.Writer) *OutStream
  • func (o *OutStream) GetTtySize() (uint, uint)
  • func (o *OutStream) Write(p []byte) (int, error)
• type Shell
  • func NewShell(homeDir string) *Shell
  • func (s *Shell) Execute(cmd []string) error

Functions

func MonitorTtySize

func MonitorTtySize(ctx context.Context, client *client.Client, out *OutStream, id string, isExec bool) error

MonitorTtySize updates the container tty size when the terminal tty changes size

Types

type CommonStream

type CommonStream struct {
	// contains filtered or unexported fields
}

CommonStream is an input stream used by the DockerCli to read user input

func (*CommonStream) FD

func (s *CommonStream) FD() uintptr

FD returns the file descriptor number for this stream

func (*CommonStream) IsTerminal

func (s *CommonStream) IsTerminal() bool

IsTerminal returns true if this stream is connected to a terminal

func (*CommonStream) RestoreTerminal

func (s *CommonStream) RestoreTerminal()

RestoreTerminal restores normal mode to the terminal

func (*CommonStream) SetIsTerminal

func (s *CommonStream) SetIsTerminal(isTerminal bool)

SetIsTerminal sets the boolean used for isTerminal

func (*CommonStream) SetRawMode

func (s *CommonStream) SetRawMode()

SetRawMode sets the stream in raw mode.

type InStream

type InStream struct {
	CommonStream
	// contains filtered or unexported fields
}

InStream is an input stream used by the DockerCli to read user input

func NewInStream

func NewInStream(in io.ReadCloser) *InStream

NewInStream returns a new InStream object from a ReadCloser

func (*InStream) Close

func (i *InStream) Close() error

Close implements the Closer interface

func (*InStream) IsTty

func (i *InStream) IsTty() bool

IsTty checks if the input is a tty.

func (*InStream) Read

func (i *InStream) Read(p []byte) (int, error)

type OutStream

type OutStream struct {
	CommonStream
	// contains filtered or unexported fields
}

OutStream is an output stream used by the DockerCli to write normal program output.

func NewOutStream

func NewOutStream(out io.Writer) *OutStream

NewOutStream returns a new OutStream object from a Writer

func (*OutStream) GetTtySize

func (o *OutStream) GetTtySize() (uint, uint)

GetTtySize returns the height and width in characters of the tty

func (*OutStream) Write

func (o *OutStream) Write(p []byte) (int, error)

type Shell

type Shell struct {
	// contains filtered or unexported fields
}

Shell holds an instance of a user's interaction with a Docker container.

func NewShell

func NewShell(homeDir string) *Shell

NewShell builds a new shell instance.

func (*Shell) Execute

func (s *Shell) Execute(cmd []string) error

Execute executes the shell, redirecting stdin.