ws

Documentation

Index

• Constants
• type Base
  • func (h *Base) Close()
  • func (h *Base) CreateWsConn(host, path string)
• type Conn
  • func NewWsConn(host, path string, eventStream chan *Event) *Conn
  • func (ws *Conn) CloseWs()
  • func (ws *Conn) Reconnect(err error)
  • func (ws *Conn) Shutdown()
  • func (ws *Conn) StartToHeartbeat(f func() string, interval time.Duration)
  • func (ws *Conn) StartToReceiveMessage()
  • func (ws *Conn) Subscribe(subEvent interface{})
  • func (ws *Conn) Write(f func())
• type Event

Constants

const (
	// Create Connection
	EventCreateConnection = iota
	// HeartBeat
	EventHeartBeat
	// Message
	EventMessage
	// Close Socket
	EventSocketClose
	// Subscribe
	EventSubscribe
	// Reconnect
	EventReconnect
)

Types

type Base

type Base struct {
	Host           string
	Ws             *Conn
	EventStream    chan *Event
	MessageHandler func(msg []byte)
	OnWSCreated    func()
	// contains filtered or unexported fields
}

func (*Base) Close

func (h *Base) Close()

func (*Base) CreateWsConn

func (h *Base) CreateWsConn(host, path string)

type Conn

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

func NewWsConn

func NewWsConn(host, path string, eventStream chan *Event) *Conn

func (*Conn) CloseWs

func (ws *Conn) CloseWs()

func (*Conn) Reconnect

func (ws *Conn) Reconnect(err error)

func (*Conn) Shutdown

func (ws *Conn) Shutdown()

func (*Conn) StartToHeartbeat

func (ws *Conn) StartToHeartbeat(f func() string, interval time.Duration)

func (*Conn) StartToReceiveMessage

func (ws *Conn) StartToReceiveMessage()

func (*Conn) Subscribe

func (ws *Conn) Subscribe(subEvent interface{})

func (*Conn) Write

func (ws *Conn) Write(f func())

type Event

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