go_websocket_client

README

go-websocket-client

golang simply implement of websocket client base on gorilla/websocket

install

go get -u github.com/link-yundi/go-websocket-client

example

configuration

import github.com/link-yundi/go-websocket-client
func main() {
    ...
   	config := Config{
		Url:             "ws host",
		ProxyUrl:        "proxy host",
		PingPeriod:      15 * time.Second,
		IsAutoReconnect: true,
	}
	client := NewClient(config) 
    ...
}

start client

...
client.Start()
...

subscribe

...
client.Subscribe([]byte(`some event string`))
...

auto reconnect

...
config := Config{
    	...
    	IsAutoReconnect: true,
    	...
	}
...

close client

...
client.Terminate()
...

customize message-handler

func onMessage(msg []byte) {
    // do somthing you want
	fmt.Println("OnMessage: ", string(msg))
}

func onConnect() {
    // do somthing you want
	fmt.Println("OnConnect")
}

func onClose(code int, text string) error {
    // do somthing you want
	fmt.Println("OnClose", code, text)
	return nil
}

func main() {
    config := Config{
		...
		OnMessage:       onMessage,
		OnClose:         onClose,
		OnConnect:       onConnect,
		PingPeriod:      15 * time.Second,
		IsAutoReconnect: true,
        ...
	}
    client := NewClient(config)
    go client.Start()
    // or client.Start()
}

Documentation

Index

• type Client
  • func NewClient(config Config) *Client
  • func (client *Client) Send(msg []byte)
  • func (client *Client) SendClose()
  • func (client *Client) Start()
  • func (client *Client) Subscribe(data []byte)
  • func (client *Client) Terminate()
• type Config

Types

type Client

type Client struct {
	Config

	Subs [][]byte
	// contains filtered or unexported fields
}

func NewClient

func NewClient(config Config) *Client

func (*Client) Send

func (client *Client) Send(msg []byte)

func (*Client) SendClose

func (client *Client) SendClose()

func (*Client) Start

func (client *Client) Start()

func (*Client) Subscribe

func (client *Client) Subscribe(data []byte)

func (*Client) Terminate

func (client *Client) Terminate()

type Config

type Config struct {
	Url              string
	ProxyUrl         string
	ReqHeaders       map[string][]string
	PingPeriod       time.Duration
	IsAutoReconnect  bool
	OnConnect        func()
	OnMessage        func([]byte)
	OnClose          func(int, string) error
	OnError          func(err error)
	ReadDeadlineTime time.Duration
	ReconnectPeriod  time.Duration
}