client.go

package maxim

import (
	"net/http"
	"time"

	"github.com/gorilla/websocket"
)

// Client 呈現了一個 WebSocket 客戶端。
type Client struct {
	// Config 是客戶端設置。
	config *ClientConfig
	// conn 是底層的 WebSocket 連線。
	conn *websocket.Conn
	// isClosed 會表示此客戶端是否已經關閉連線了。
	isClosed bool
	//
	messageHandler func(*Client, string)
	//
	messageBinaryHandler func(*Client, []byte)
}

// ClientConfig 是客戶端設置。
type ClientConfig struct {
	// Address 是遠端伺服器位置（如：`ws://127.0.0.1:1234/echo`）。
	Address string
	// header 是 WebSocket 初次發送時順帶傳輸的 HTTP 標頭資訊。
	Header http.Header
	// WriteWait 是每次訊息寫入時的逾時時間。
	WriteWait time.Duration
}

// NewClient 會建立客戶端並連線到指定的 WebSocket 伺服端。
func NewClient(conf *ClientConfig) (*Client, *http.Response, error) {
	if conf.WriteWait == 0 {
		conf.WriteWait = time.Second * 30
	}
	conn, resp, err := websocket.DefaultDialer.Dial(conf.Address, conf.Header)
	if err != nil {
		return nil, resp, err
	}
	conn.SetPingHandler(func(h string) error {
		return conn.WriteControl(websocket.PongMessage, []byte(``), time.Now().Add(conf.WriteWait))
	})
	client := &Client{
		config: conf,
		conn:   conn,
	}
	return client, resp, nil
}

// ReadAll 會阻塞程式直到有訊息為止，這會接收到所有文字或二進制訊息。
//
// 注意：同時間 ReadAll、Read、ReadBinary 只能使用一個消化訊息。
func (c *Client) ReadAll() (int, []byte, error) {
	if c.isClosed {
		return 0, []byte(``), ErrClientClosed
	}
	typ, msg, err := c.conn.ReadMessage()
	if err != nil {
		return typ, msg, err
	}
	return typ, msg, nil
}

// ReadMessage 會阻塞程式直到有訊息為止，接收到的訊息會 `string` 字串標準訊息。
// 任何系統訊息像是 Ping-Pong 與 Close 都不會出現在這裡。
//
// 注意：同時間 ReadAll、Read、ReadBinary 只能使用一個消化訊息。
func (c *Client) Read() (string, error) {
	if c.isClosed {
		return "", ErrClientClosed
	}
	for {
		typ, msg, err := c.ReadAll()
		if err != nil {
			return "", err
		}
		if typ != websocket.TextMessage {
			continue
		}
		return string(msg), nil
	}
}

// ReadBinary 會阻塞程式直到有訊息為止，接收到的訊息會是 `[]byte` 二進制標準訊息。
// 任何系統訊息像是 Ping-Pong 與 Close 都不會出現在這裡。
//
// 注意：同時間 ReadAll、Read、ReadBinary 只能使用一個消化訊息。
func (c *Client) ReadBinary() ([]byte, error) {
	if c.isClosed {
		return []byte(``), ErrClientClosed
	}
	for {
		typ, msg, err := c.ReadAll()
		if err != nil {
			return []byte(``), err
		}
		if typ != websocket.BinaryMessage {
			continue
		}
		return msg, nil
	}
}

// Close 會依照正常手續告訴伺服器關閉並結束客戶端連線。
func (c *Client) Close() error {
	if c.isClosed {
		return ErrClientClosed
	}
	c.isClosed = true
	return c.conn.WriteControl(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""), time.Now().Add(c.config.WriteWait))
}

// Write 能夠傳送文字訊息至伺服端。
func (c *Client) Write(msg string) error {
	if c.isClosed {
		return ErrClientClosed
	}
	return c.conn.WriteMessage(websocket.TextMessage, []byte(msg))
}

// WriteBinary 能夠傳送二進制訊息至伺服端。
func (c *Client) WriteBinary(msg []byte) error {
	if c.isClosed {
		return ErrClientClosed
	}
	return c.conn.WriteMessage(websocket.BinaryMessage, msg)
}

// IsClosed 會表示該連線是否已經關閉並結束了。
func (c *Client) IsClosed() bool {
	return c.isClosed
}