websocket

Documentation

Index

• Constants
• func EncodeUserEmailtoID(email string) string
• func Terminal(ctx context.Context, ws *websocket.Conn, client ctrlruntimeclient.Client, ...)
• func WriteSettings(ctx context.Context, providers watcher.Providers, ws *websocket.Conn)
• func WriteUser(ctx context.Context, providers watcher.Providers, ws *websocket.Conn, ...)
• type PtyHandler
• type TerminalMessage
• type TerminalSession
  • 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)

Constants

const END_OF_TRANSMISSION = "\u0004"

Functions

func EncodeUserEmailtoID

func EncodeUserEmailtoID(email string) string

func Terminal

func Terminal(ctx context.Context, ws *websocket.Conn, client ctrlruntimeclient.Client, k8sClient kubernetes.Interface, cfg *restclient.Config, podName string)

Terminal is called for any new websocket connection.

func WriteSettings

func WriteSettings(ctx context.Context, providers watcher.Providers, ws *websocket.Conn)

func WriteUser

func WriteUser(ctx context.Context, providers watcher.Providers, ws *websocket.Conn, userEmail string)

Types

type PtyHandler

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

PtyHandler is what remote command expects from a pty.

type TerminalMessage

type TerminalMessage struct {
	Op, Data, SessionID 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 websocket connection).

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.