zws

README

zws

websocket client

Usage

package main

import (
	"log"
	"time"
	"github.com/zohu/zws"
)

func main() {
	done := make(chan bool)
	ws := zws.New("ws://127.0.0.1:7777/ws")
	// 可自定义配置，不使用默认配置
	//ws.SetConfig(&zws.Config{
	//	// 写超时
	//	WriteWait: 10 * time.Second,
	//	// 支持接受的消息最大长度，默认512字节
	//	MaxMessageSize: 2048,
	//	// 最小重连时间间隔
	//	MinRecTime: 2 * time.Second,
	//	// 最大重连时间间隔
	//	MaxRecTime: 60 * time.Second,
	//	// 每次重连失败继续重连的时间间隔递增的乘数因子，递增到最大重连时间间隔为止
	//	RecFactor: 1.5,
	//	// 消息发送缓冲池大小，默认256
	//	MessageBufferSize: 1024,
	//})
	// 设置回调处理
	ws.OnConnected(func() {
		log.Println("OnConnected: ", ws.WebSocket.Url)
		// 连接成功后，测试每5秒发送消息
		go func() {
			t := time.NewTicker(5 * time.Second)
			for {
				select {
				case <-t.C:
					err := ws.SendTextMessage("hello")
					if err == zws.CloseErr {
						return
					}
				}
			}
		}()
	})
	ws.OnConnectError(func(err error) {
		log.Println("OnConnectError: ", err.Error())
	})
	ws.OnDisconnected(func(err error) {
		log.Println("OnDisconnected: ", err.Error())
	})
	ws.OnClose(func(code int, text string) {
		log.Println("OnClose: ", code, text)
		done <- true
	})
	ws.OnTextMessageSent(func(message string) {
		log.Println("OnTextMessageSent: ", message)
	})
	ws.OnBinaryMessageSent(func(data []byte) {
		log.Println("OnBinaryMessageSent: ", string(data))
	})
	ws.OnSentError(func(err error) {
		log.Println("OnSentError: ", err.Error())
	})
	ws.OnPingReceived(func(appData string) {
		log.Println("OnPingReceived: ", appData)
	})
	ws.OnPongReceived(func(appData string) {
		log.Println("OnPongReceived: ", appData)
	})
	ws.OnTextMessageReceived(func(message string) {
		log.Println("OnTextMessageReceived: ", message)
	})
	ws.OnBinaryMessageReceived(func(data []byte) {
		log.Println("OnBinaryMessageReceived: ", string(data))
	})
	// 开始连接
	go ws.Connect()
	for {
		select {
		case <-done:
			return
		}
	}
}

Documentation

Index

• Variables
• type Config
• type WebSocket
• type Wsc
  • func New(url string) *Wsc
  • func (wsc *Wsc) Close()
  • func (wsc *Wsc) CloseWithMsg(msg string)
  • func (wsc *Wsc) Closed() bool
  • func (wsc *Wsc) Connect()
  • func (wsc *Wsc) OnBinaryMessageReceived(f func(data []byte))
  • func (wsc *Wsc) OnBinaryMessageSent(f func(data []byte))
  • func (wsc *Wsc) OnClose(f func(code int, text string))
  • func (wsc *Wsc) OnConnectError(f func(err error))
  • func (wsc *Wsc) OnConnected(f func())
  • func (wsc *Wsc) OnDisconnected(f func(err error))
  • func (wsc *Wsc) OnPingReceived(f func(appData string))
  • func (wsc *Wsc) OnPongReceived(f func(appData string))
  • func (wsc *Wsc) OnSentError(f func(err error))
  • func (wsc *Wsc) OnTextMessageReceived(f func(message string))
  • func (wsc *Wsc) OnTextMessageSent(f func(message string))
  • func (wsc *Wsc) SendBinaryMessage(data []byte) error
  • func (wsc *Wsc) SendTextMessage(message string) error
  • func (wsc *Wsc) SetConfig(config *Config)

Variables

var (
	CloseErr  = errors.New("链接已关闭")
	BufferErr = errors.New("消息缓存区已满")
)

Types

type Config

type Config struct {
	// 写超时
	WriteWait time.Duration
	// 支持接受的消息最大长度，默认512字节
	MaxMessageSize int64
	// 最小重连时间间隔
	MinRecTime time.Duration
	// 最大重连时间间隔
	MaxRecTime time.Duration
	// 每次重连失败继续重连的时间间隔递增的乘数因子，递增到最大重连时间间隔为止
	RecFactor float64
	// 消息发送缓冲池大小，默认256
	MessageBufferSize int
}

type WebSocket

type WebSocket struct {
	// 连接url
	Url           string
	Conn          *websocket.Conn
	Dialer        *websocket.Dialer
	RequestHeader http.Header
	HttpResponse  *http.Response
	// contains filtered or unexported fields
}

type Wsc

type Wsc struct {
	// 配置信息
	Config *Config
	// 底层WebSocket
	WebSocket *WebSocket
	// contains filtered or unexported fields
}

func New

func New(url string) *Wsc

New @Description: 创建一个Wsc客户端 @param url @return *Wsc

func (*Wsc) Close

func (wsc *Wsc) Close()

Close @Description: 主动关闭连接 @receiver ws

func (*Wsc) CloseWithMsg

func (wsc *Wsc) CloseWithMsg(msg string)

CloseWithMsg @Description: 主动关闭连接，附带消息 @receiver ws @param msg

func (*Wsc) Closed

func (wsc *Wsc) Closed() bool

Closed @Description: 返回关闭状态 @receiver ws @return bool

func (*Wsc) Connect

func (wsc *Wsc) Connect()

Connect @Description: 发起连接 @receiver ws

func (*Wsc) OnBinaryMessageReceived

func (wsc *Wsc) OnBinaryMessageReceived(f func(data []byte))

func (*Wsc) OnBinaryMessageSent

func (wsc *Wsc) OnBinaryMessageSent(f func(data []byte))

func (*Wsc) OnClose

func (wsc *Wsc) OnClose(f func(code int, text string))

func (*Wsc) OnConnectError

func (wsc *Wsc) OnConnectError(f func(err error))

func (*Wsc) OnConnected

func (wsc *Wsc) OnConnected(f func())

func (*Wsc) OnDisconnected

func (wsc *Wsc) OnDisconnected(f func(err error))

func (*Wsc) OnPingReceived

func (wsc *Wsc) OnPingReceived(f func(appData string))

func (*Wsc) OnPongReceived

func (wsc *Wsc) OnPongReceived(f func(appData string))

func (*Wsc) OnSentError

func (wsc *Wsc) OnSentError(f func(err error))

func (*Wsc) OnTextMessageReceived

func (wsc *Wsc) OnTextMessageReceived(f func(message string))

func (*Wsc) OnTextMessageSent

func (wsc *Wsc) OnTextMessageSent(f func(message string))

func (*Wsc) SendBinaryMessage

func (wsc *Wsc) SendBinaryMessage(data []byte) error

SendBinaryMessage @Description: 发送BinaryMessage消息 @receiver ws @param data @return error

func (*Wsc) SendTextMessage

func (wsc *Wsc) SendTextMessage(message string) error

SendTextMessage @Description: 发送TextMessage消息 @receiver ws @param message @return error

func (*Wsc) SetConfig

func (wsc *Wsc) SetConfig(config *Config)