connector

Documentation

Overview

Note: this package is not used now, just for websocket in future!

Note: this package is not used now, just for websocket in future!

Index

• Variables
• type ConnectStatus
• type HConn
  • func NewConn(urlStr string, header http.Header) *HConn
  • func (c *HConn) CheckHealth() bool
  • func (c *HConn) Close()
  • func (c *HConn) ReadMessage() (int, []byte, error)
  • func (c *HConn) SetWriteDeadline(t time.Time) error
  • func (c *HConn) Status() ConnectStatus
  • func (c *HConn) WriteMessage(messageType int, data []byte) error
• type JsonResponse
• type Message
  • func NewJsonMessage(data, err string) *Message
  • func NewMessage(typ MessageType, mod Module, data []byte) *Message
  • func (m *Message) Serialize() ([]byte, error)
• type MessageBytes
  • func (mb MessageBytes) Deserialize() (Message, error)
• type MessageError
• type MessageType
• type Module

Variables

var (
	ErrConnectClosed    = errors.New("connection closed")
	ErrConnectReconnect = errors.New("connection reconnecting")
)

Types

type ConnectStatus

type ConnectStatus int32

const (
	ConnectOpen ConnectStatus = iota
	ConnectClosed
	ConnectReconnect
)

type HConn

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

HConn examines the liveness of the underground connection periodically, and reconnects to the remote when the underground connection is unexpectedly closed

func NewConn

func NewConn(urlStr string, header http.Header) *HConn

func (*HConn) CheckHealth

func (c *HConn) CheckHealth() bool

func (*HConn) Close

func (c *HConn) Close()

func (*HConn) ReadMessage

func (c *HConn) ReadMessage() (int, []byte, error)

func (*HConn) SetWriteDeadline

func (c *HConn) SetWriteDeadline(t time.Time) error

func (*HConn) Status

func (c *HConn) Status() ConnectStatus

func (*HConn) WriteMessage

func (c *HConn) WriteMessage(messageType int, data []byte) error

type JsonResponse

type JsonResponse struct {
	Out string `json:"output"`
	Err string `json:"output_error"`
}

type Message

type Message struct {
	Type      MessageType
	Timestamp string
	Module    Module
	Session   string
	Payload   json.RawMessage
}

func NewJsonMessage

func NewJsonMessage(data, err string) *Message

func NewMessage

func NewMessage(typ MessageType, mod Module, data []byte) *Message

func (*Message) Serialize

func (m *Message) Serialize() ([]byte, error)

type MessageBytes

type MessageBytes []byte

func (MessageBytes) Deserialize

func (mb MessageBytes) Deserialize() (Message, error)

type MessageError

type MessageError struct {
	Err error
	Msg *Message
}

type MessageType

type MessageType string

const (
	FileType    MessageType = "file"
	CommandType MessageType = "command"
	JsonType    MessageType = "json"
)

type Module

type Module string

const (
	PythonModule Module = "python"
	ShellModule  Module = "shell"
	FetchModule  Module = "fetch"
	CopyModule   Module = "copy"
)