terminal

Documentation

Index

• type Interface
  • func NewTerminaler(client kubernetes.Interface, config *rest.Config) Interface
• type PtyHandler
• type TerminalMessage
• type TerminalSession
  • func (t TerminalSession) Close(status uint32, reason string)
  • func (t TerminalSession) Next() *remotecommand.TerminalSize
  • func (t TerminalSession) Read(p []byte) (int, error)
  • func (t TerminalSession) Toast(p string) error
  • func (t TerminalSession) Write(p []byte) (int, error)

Types

type Interface

type Interface interface {
	HandleSession(shell, namespace, podName, containerName string, conn *websocket.Conn)
}

func NewTerminaler

func NewTerminaler(client kubernetes.Interface, config *rest.Config) Interface

type PtyHandler

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

PtyHandler is what remotecommand expects from a pty

type TerminalMessage

type TerminalMessage struct {
	Op, Data   string
	Rows, Cols uint16
}

TerminalMessage is the messaging protocol between ShellController and TerminalSession.

OP DIRECTION FIELD(S) USED DESCRIPTION --------------------------------------------------------------------- stdin fe->be Data Keystrokes/paste buffer resize fe->be Rows, Cols New terminal size stdout be->fe Data Output from the process toast be->fe Data OOB message to be shown to the user

type TerminalSession

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

TerminalSession implements PtyHandler (using a SockJS connection)

func (TerminalSession) Close

func (t TerminalSession) Close(status uint32, reason string)

Close shuts down the SockJS connection and sends the status code and reason to the client Can happen if the process exits or if there is an error starting up the process For now the status code is unused and reason is shown to the user (unless "")

func (TerminalSession) Next

func (t TerminalSession) Next() *remotecommand.TerminalSize

TerminalSize handles pty->process resize events Called in a loop from remotecommand as long as the process is running

func (TerminalSession) Read

func (t TerminalSession) Read(p []byte) (int, error)

Read handles pty->process messages (stdin, resize) Called in a loop from remotecommand as long as the process is running

func (TerminalSession) Toast

func (t TerminalSession) Toast(p string) error

Toast can be used to send the user any OOB messages hterm puts these in the center of the terminal

func (TerminalSession) Write

func (t TerminalSession) Write(p []byte) (int, error)

Write handles process->pty stdout Called from remotecommand whenever there is any output