terminal

Documentation

Index

• type Instance
  • func NewTerminalInstance(ctx context.Context, client cluster.ClientInterface, logger log.Logger, ...) (Instance, error)
• type PTY

Types

type Instance

type Instance interface {
	Key() store.Key
	Container() string
	Command() string
	Scrollback() []byte
	ResetScrollback()

	Read(size int) ([]byte, error)
	Write(key []byte) error
	Resize(cols, rows uint16)

	Stop()
	Active() bool
	SetExitMessage(string)
	ExitMessage() string
	StreamError() error
	CreatedAt() time.Time

	PTY() PTY
	DiscoveryClient() discovery.DiscoveryInterface
}

Instance defines the interface to a single exec instance.

func NewTerminalInstance

func NewTerminalInstance(ctx context.Context, client cluster.ClientInterface, logger log.Logger, key store.Key, container, command string, activityChan chan Instance) (Instance, error)

NewTerminalInstance creates a concrete Terminal

type PTY

type PTY interface {
	io.Reader
	io.Writer
	remotecommand.TerminalSizeQueue
}