tty

Documentation

Index

• Constants
• type MsgTTYWinSize
• type MsgTTYWrite
• type MsgWrapper
• type OnMsgWinSize
• type OnMsgWrite
• type PTYHandler
• type TTYProtocolWSLocked
  • func NewTTYProtocolWSLocked(ws *websocket.Conn) *TTYProtocolWSLocked
  • func (handler *TTYProtocolWSLocked) ReadAndHandle(onWrite OnMsgWrite, onWinSize OnMsgWinSize) (err error)
  • func (handler *TTYProtocolWSLocked) SetWinSize(cols, rows int) (err error)
  • func (handler *TTYProtocolWSLocked) Write(buff []byte) (n int, err error)
• type TTYShareSession
  • func NewTTYShareSession(ptyHandler PTYHandler) *TTYShareSession
  • func (session *TTYShareSession) HandleWSConnection(wsConn *websocket.Conn)
  • func (session *TTYShareSession) WindowSize(cols, rows int) error
  • func (session *TTYShareSession) Write(data []byte) (int, error)

Constants

const (
	MsgIDWrite   = "Write"
	MsgIDWinSize = "WinSize"
)

Types

type MsgTTYWinSize

type MsgTTYWinSize struct {
	Cols int
	Rows int
}

type MsgTTYWrite

type MsgTTYWrite struct {
	Data []byte
	Size int
}

type MsgWrapper

type MsgWrapper struct {
	Type string
	Data []byte
}

Message used to encapsulate the rest of the bessages bellow

type OnMsgWinSize

type OnMsgWinSize func(cols, rows int)

type OnMsgWrite

type OnMsgWrite func(data []byte)

type PTYHandler

type PTYHandler interface {
	Write(data []byte) (int, error)
	Refresh()
}

type TTYProtocolWSLocked

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

func NewTTYProtocolWSLocked

func NewTTYProtocolWSLocked(ws *websocket.Conn) *TTYProtocolWSLocked

func (*TTYProtocolWSLocked) ReadAndHandle

func (handler *TTYProtocolWSLocked) ReadAndHandle(onWrite OnMsgWrite, onWinSize OnMsgWinSize) (err error)

func (*TTYProtocolWSLocked) SetWinSize

func (handler *TTYProtocolWSLocked) SetWinSize(cols, rows int) (err error)

func (*TTYProtocolWSLocked) Write

func (handler *TTYProtocolWSLocked) Write(buff []byte) (n int, err error)

Function to send data from one the sender to the server and the other way around.

type TTYShareSession

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

func NewTTYShareSession

func NewTTYShareSession(ptyHandler PTYHandler) *TTYShareSession

func (*TTYShareSession) HandleWSConnection

func (session *TTYShareSession) HandleWSConnection(wsConn *websocket.Conn)

Will run on the TTYReceiver connection go routine (e.g.: on the websockets connection routine) When HandleWSConnection will exit, the connection to the TTYReceiver will be closed

func (*TTYShareSession) WindowSize

func (session *TTYShareSession) WindowSize(cols, rows int) error

func (*TTYShareSession) Write

func (session *TTYShareSession) Write(data []byte) (int, error)