terminal

Documentation

Index

• type Instance
  • func NewTerminalInstance(ctx context.Context, logger log.Logger, key store.Key, ...) Instance
• type Manager
  • func NewTerminalManager(ctx context.Context, client cluster.ClientInterface, objectStore store.Store) (Manager, error)
• type PTY

Types

type Instance

type Instance interface {
	ID() string
	SessionID() string
	SetSessionID(string)
	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
	CreatedAt() time.Time

	PTY() PTY
}

Instance defines the interface to a single exec instance.

func NewTerminalInstance

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

NewTerminalInstance creates a concrete Terminal

type Manager

type Manager interface {
	List(namespace string) []Instance
	Get(id string) (Instance, bool)
	Delete(id string)
	Create(ctx context.Context, logger log.Logger, key store.Key, container string, command string, sessionID string) (Instance, error)
	Select(ctx context.Context) chan Instance
	ForceUpdate(id string)
	SendScrollback(id string) bool
	SetScrollback(id string, send bool)
	StopAll() error
}

Manager defines the interface for querying terminal instance.

func NewTerminalManager

func NewTerminalManager(ctx context.Context, client cluster.ClientInterface, objectStore store.Store) (Manager, error)

NewTerminalManager creates a concrete TerminalMananger

type PTY

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