websocket

Documentation

Index

• Constants
• Variables
• type HostStatusRequest
• type Request
• type SSHSession
  • func NewSshConn(cols, rows int, sshClient *transport.Client) (*SSHSession, error)
  • func (s *SSHSession) Close()
  • func (s *SSHSession) ReceiveWsMsg(wsConn *websocket.Conn, exitCh chan struct{})
  • func (s *SSHSession) SendComboOutput(wsConn *websocket.Conn, exitCh chan struct{})
  • func (s *SSHSession) SessionWait(quitChan chan struct{})
• type VNCForward
  • func NewVNCForward(wsConn *websocket.Conn, tcpConn net.Conn, logger *logger.Logger, ...) *VNCForward
  • func (vf *VNCForward) Close()
  • func (vf *VNCForward) Serve()
• type WSConnect
  • func NewWSConnect(conn *websocket.Conn, engine WebService) *WSConnect
  • func (w *WSConnect) Close() error
  • func (w *WSConnect) HandlerFTaskStatus(conn *websocket.Conn, msg *WsMsg)
  • func (w *WSConnect) HandlerHostStatus(conn *websocket.Conn, msg *WsMsg)
  • func (w *WSConnect) HandlerResize(conn *websocket.Conn, msg *WsMsg)
  • func (w *WSConnect) HandlerSSHShell(conn *websocket.Conn, msg *WsMsg)
  • func (w *WSConnect) InitHandlers() *WSConnect
  • func (w *WSConnect) Serve()
  • func (w *WSConnect) WriteMsg(msg interface{})
• type WebService
• type WsHandler
• type WsMsg

Constants

const (
	EventCancel  = "cancel"
	EventConnect = "connect"
)

const (
	WSStatusSuccess = "0"
	WSStatusError   = "-1"

	DefaultStatusInterval = 2 * time.Second
)

Variables

var (
	DefaultSSHCMDTimeout = time.Duration(utils.GetEnvInt("ENV_SSH_CMD_TIMEOUT", defaultSSHCMDTimeout)) * time.Second
)

Types

type HostStatusRequest

type HostStatusRequest struct {
	Request
	Interval int `json:"interval"`
}

type Request

type Request struct {
	Type  string `json:"type"`
	Id    int    `json:"id"`
	Cmd   string `json:"cmd"`
	CType string `json:"cmd_type"`
	CmdId int    `json:"cmd_id"`
}

type SSHSession

type SSHSession struct {
	*transport.Session
	// contains filtered or unexported fields
}

SSHSession connect to ssh server using ssh session.

func NewSshConn

func NewSshConn(cols, rows int, sshClient *transport.Client) (*SSHSession, error)

func (*SSHSession) Close

func (s *SSHSession) Close()

func (*SSHSession) ReceiveWsMsg

func (s *SSHSession) ReceiveWsMsg(wsConn *websocket.Conn, exitCh chan struct{})

ReceiveWsMsg receive websocket msg do some handling then write into ssh.session.stdin

func (*SSHSession) SendComboOutput

func (s *SSHSession) SendComboOutput(wsConn *websocket.Conn, exitCh chan struct{})

func (*SSHSession) SessionWait

func (s *SSHSession) SessionWait(quitChan chan struct{})

type VNCForward

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

func NewVNCForward

func NewVNCForward(wsConn *websocket.Conn, tcpConn net.Conn, logger *logger.Logger, quitChan chan struct{}) *VNCForward

func (*VNCForward) Close

func (vf *VNCForward) Close()

func (*VNCForward) Serve

func (vf *VNCForward) Serve()

type WSConnect

type WSConnect struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

func NewWSConnect

func NewWSConnect(conn *websocket.Conn, engine WebService) *WSConnect

func (*WSConnect) Close

func (w *WSConnect) Close() error

func (*WSConnect) HandlerFTaskStatus

func (w *WSConnect) HandlerFTaskStatus(conn *websocket.Conn, msg *WsMsg)

func (*WSConnect) HandlerHostStatus

func (w *WSConnect) HandlerHostStatus(conn *websocket.Conn, msg *WsMsg)

func (*WSConnect) HandlerResize

func (w *WSConnect) HandlerResize(conn *websocket.Conn, msg *WsMsg)

func (*WSConnect) HandlerSSHShell

func (w *WSConnect) HandlerSSHShell(conn *websocket.Conn, msg *WsMsg)

func (*WSConnect) InitHandlers

func (w *WSConnect) InitHandlers() *WSConnect

func (*WSConnect) Serve

func (w *WSConnect) Serve()

func (*WSConnect) WriteMsg

func (w *WSConnect) WriteMsg(msg interface{})

type WebService

type WebService interface {
	RunCmdWithContext(host *models.Host, cmd ssh.Command, ch chan *ssh.Result)
	GetSSHManager() *ssh.Manager
}

type WsHandler

type WsHandler func(conn *websocket.Conn, msg *WsMsg)

type WsMsg

type WsMsg struct {
	Type  string      `json:"type"`
	Data  interface{} `json:"data"`
	Event string      `json:"event"`
	Body  []byte      `json:"-"`
}