ww

Documentation

Index

• Constants
• func Debug(format string, v ...interface{})
• func Error(format string, v ...interface{})
• func Info(format string, v ...interface{})
• func Notice(format string, v ...interface{})
• func SetLogger(l logger)
• func Warning(format string, v ...interface{})
• type WSClient
  • func (ws *WSClient) RefreshReconnectMsg(reconnectMsg *WSMessage)
  • func (ws *WSClient) SendMessge(msg *WSMessage) (err error)
  • func (ws *WSClient) Shutdown() error
  • func (ws *WSClient) Startup(remoteAddr, remotePath string, reconnectTime time.Duration, ...) error
• type WSHandle
  • func (h WSHandle) SendMessage(msg *WSMessage) (err error)
• type WSMessage
• type WSMessageType
• type WSServerHandler
  • func (ws *WSServerHandler) OnHandler(w http.ResponseWriter, r *http.Request)
• type WSServerInterface

Constants

const (
	// for business message
	WSMessageTypeBusiness = WSMessageType(1)
	// for control message (close connection)
	WSMessageTypeClose = WSMessageType(2)
)

Functions

func Debug

func Debug(format string, v ...interface{})

func Error

func Error(format string, v ...interface{})

func Info

func Info(format string, v ...interface{})

func Notice

func Notice(format string, v ...interface{})

func SetLogger

func SetLogger(l logger)

func Warning

func Warning(format string, v ...interface{})

Types

type WSClient

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

func (*WSClient) RefreshReconnectMsg

func (ws *WSClient) RefreshReconnectMsg(reconnectMsg *WSMessage)

RefreshReconnectMsg can refresh the client's reconnect message

func (*WSClient) SendMessge

func (ws *WSClient) SendMessge(msg *WSMessage) (err error)

func (*WSClient) Shutdown

func (ws *WSClient) Shutdown() error

func (*WSClient) Startup

func (ws *WSClient) Startup(remoteAddr, remotePath string, reconnectTime time.Duration,
	onMessage func([]byte, error), onClose func(), reconnectMsg *WSMessage) error

type WSHandle

type WSHandle uint64

WSHandle means a websocket connection

func (WSHandle) SendMessage

func (h WSHandle) SendMessage(msg *WSMessage) (err error)

SendMessge ,send a message to chan

type WSMessage

type WSMessage struct {
	// Type determine the message is business message or not
	Type WSMessageType
	// Data save the concrete datas for translation
	Data []byte
}

type WSMessageType

type WSMessageType int64

type WSServerHandler

type WSServerHandler struct {
	On WSServerInterface
}

func (*WSServerHandler) OnHandler

func (ws *WSServerHandler) OnHandler(w http.ResponseWriter, r *http.Request)

OnHandler contains a connection and open a routine for recv

type WSServerInterface

type WSServerInterface interface {
	OnMessage(WSHandle, []byte, error)
	OnClose(WSHandle)
}