channel

Documentation

Index

• Constants
• func BuildInvalidRet(desc string) string
• func ChannelTypeStr(channelType int) string
• func GetCurrentChannelType() int
• func InitChannelMgr(CallBack OnReceiveMsg) error
• func OnNetworkRecover()
• func OnRecvMsg(Msg string, ChannelType int) string
• func StartChannelMgr()
• func TryStartGshellChannel()
• type Channel
  • func (c *Channel) GetChannelType() int
  • func (c *Channel) IsWorking() bool
• type ChannelMgr
  • func (m *ChannelMgr) GetCurrentChannelType() int
  • func (m *ChannelMgr) Init(CallBack OnReceiveMsg) error
  • func (m *ChannelMgr) SelectAvailableChannel(currentChannel int) error
  • func (m *ChannelMgr) SelectAvailableChannelAndReport(currentChannel int, reason string, ignoreFailed bool) error
• type GshellChannel
  • func (c *GshellChannel) IsSupported() bool
  • func (c *GshellChannel) StartChannel() error
  • func (c *GshellChannel) StopChannel() error
  • func (c *GshellChannel) SwitchChannel() error
• type GshellCheck
• type GshellCheckReply
• type GshellCmd
• type GshellCmdReply
• type GshellInvalid
• type GshellShutdown
• type IChannel
  • func NewGshellChannel(CallBack OnReceiveMsg) IChannel
• type NetcheckReply
  • func LastNetcheckReply() *NetcheckReply
• type OnReceiveMsg
• type WebSocketChannel
  • func NewWebsocketChannel(CallBack OnReceiveMsg) *WebSocketChannel
  • func (c *WebSocketChannel) IsSupported() bool
  • func (c *WebSocketChannel) ResetFailedCount()
  • func (c *WebSocketChannel) StartChannel() error
  • func (c *WebSocketChannel) StartPings(pingInterval time.Duration)
  • func (c *WebSocketChannel) StopChannel() error
  • func (c *WebSocketChannel) SwitchChannel() error

Constants

const (
	ChannelNone          = 0
	ChannelGshellType    = 1
	ChannelWebsocketType = 2
)

const (
	WEBSOCKET_SERVER = "/luban/notify_server"
	MAX_RETRY_COUNT  = 5
)

Functions

func BuildInvalidRet

func BuildInvalidRet(desc string) string

func ChannelTypeStr

func ChannelTypeStr(channelType int) string

func GetCurrentChannelType

func GetCurrentChannelType() int

func InitChannelMgr

func InitChannelMgr(CallBack OnReceiveMsg) error

func OnNetworkRecover

func OnNetworkRecover()

OnNetworkRecover will be called when network recover

func OnRecvMsg

func OnRecvMsg(Msg string, ChannelType int) string

func StartChannelMgr

func StartChannelMgr()

func TryStartGshellChannel

func TryStartGshellChannel()

Types

type Channel

type Channel struct {
	CallBack    OnReceiveMsg
	ChannelType int
	Working     atomicutil.AtomicBoolean
}

func (*Channel) GetChannelType

func (c *Channel) GetChannelType() int

func (*Channel) IsWorking

func (c *Channel) IsWorking() bool

type ChannelMgr

type ChannelMgr struct {
	ActiveChannel   IChannel   //current used channel
	AllChannel      []IChannel //the first one is GshellChannel
	StopChanelEvent chan struct{}
	WaitCheckDone   sync.WaitGroup
	ChannelSetLock  sync.Mutex
}

manage all channels

var G_ChannelMgr *ChannelMgr = &ChannelMgr{
	StopChanelEvent: make(chan struct{}),
}

new

func (*ChannelMgr) GetCurrentChannelType

func (m *ChannelMgr) GetCurrentChannelType() int

func (*ChannelMgr) Init

func (m *ChannelMgr) Init(CallBack OnReceiveMsg) error

func (*ChannelMgr) SelectAvailableChannel

func (m *ChannelMgr) SelectAvailableChannel(currentChannel int) error

func (*ChannelMgr) SelectAvailableChannelAndReport

func (m *ChannelMgr) SelectAvailableChannelAndReport(currentChannel int, reason string, ignoreFailed bool) error

SelectAvailableChannelAndReport will call SelectAvailableChannel and report the result, but the failure will not be reported if ignoreFailed is true.

type GshellChannel

type GshellChannel struct {
	*Channel

	WaitCheckDone sync.WaitGroup
	// contains filtered or unexported fields
}

func (*GshellChannel) IsSupported

func (c *GshellChannel) IsSupported() bool

func (*GshellChannel) StartChannel

func (c *GshellChannel) StartChannel() error

func (*GshellChannel) StopChannel

func (c *GshellChannel) StopChannel() error

func (*GshellChannel) SwitchChannel

func (c *GshellChannel) SwitchChannel() error

type GshellCheck

type GshellCheck struct {
	Execute   string `json:"execute"`
	Arguments struct {
		ID int64 `json:"id"`
	} `json:"arguments"`
}

type GshellCheckReply

type GshellCheckReply struct {
	Return int64 `json:"return"`
}

type GshellCmd

type GshellCmd struct {
	Execute   string `json:"execute"`
	Arguments struct {
		Cmd string `json:"cmd"`
	} `json:"arguments"`
}

type GshellCmdReply

type GshellCmdReply struct {
	Return struct {
		CmdOutput string `json:"cmd_output"`
		// netcheck field would not presented when no diagnostic result available
		Netcheck *NetcheckReply `json:"netcheck,omitempty"`
		Result   int            `json:"result"`
	} `json:"return"`
}

type GshellInvalid

type GshellInvalid struct {
	Error struct {
		Class string `json:"class"`
		Desc  string `json:"desc"`
	} `json:"error"`
}

type GshellShutdown

type GshellShutdown struct {
	Execute   string `json:"execute"`
	Arguments struct {
		Mode string `json:"mode"`
	} `json:"arguments"`
}

type IChannel

type IChannel interface {
	//Is current channel working
	IsWorking() bool
	//Is current channel supported
	IsSupported() bool
	//Get Channel Type
	GetChannelType() int
	//Start channel
	StartChannel() error
	//Stop channel
	StopChannel() error
}

Abstract base class for channel

func NewGshellChannel

func NewGshellChannel(CallBack OnReceiveMsg) IChannel

type NetcheckReply

type NetcheckReply struct {
	Result    int   `json:"result"`
	Timestamp int64 `json:"timestamp"`
}

NetcheckReply represents

func LastNetcheckReply

func LastNetcheckReply() *NetcheckReply

type OnReceiveMsg

type OnReceiveMsg func(Msg string, ChannelType int) string

type WebSocketChannel

type WebSocketChannel struct {
	*Channel
	// contains filtered or unexported fields
}

func NewWebsocketChannel

func NewWebsocketChannel(CallBack OnReceiveMsg) *WebSocketChannel

func (*WebSocketChannel) IsSupported

func (c *WebSocketChannel) IsSupported() bool

func (*WebSocketChannel) ResetFailedCount

func (c *WebSocketChannel) ResetFailedCount()

func (*WebSocketChannel) StartChannel

func (c *WebSocketChannel) StartChannel() error

func (*WebSocketChannel) StartPings

func (c *WebSocketChannel) StartPings(pingInterval time.Duration)

func (*WebSocketChannel) StopChannel

func (c *WebSocketChannel) StopChannel() error

func (*WebSocketChannel) SwitchChannel

func (c *WebSocketChannel) SwitchChannel() error