gows

README

goWs

基于 gorilla 封装的并发安全的 Golang Websocket 组件

快速开始

import (
   "fmt"
   ws "github.com/lcr2000/goWs"
   "net/http"
)

func WsHandler(w http.ResponseWriter, r *http.Request) {
   // 新建连接实例
   conn := ws.NewConnection()
   // 开启连接
   if err := conn.Open(w, r); err != nil {
   	return
   }
   // 关闭连接
   defer conn.Close()
   for {
   	// 读取消息
   	msg, err := conn.Receive()
   	if err != nil {
   		break
   	}
   	fmt.Println(string(msg.Data))
   	// 发送消息
   	err = conn.Write(&ws.Message{
   		MessageType: msg.MessageType,
   		Data:        msg.Data,
   	})
   	if err != nil {
   		break
   	}
   }
}

Documentation

Index

• Constants
• Variables
• type Conn
• type Connection
  • func NewConnection(opts ...*Options) *Connection
  • func (c *Connection) Close() error
  • func (c *Connection) GetConnID() string
  • func (c *Connection) GetRemoteAddr() net.Addr
  • func (c *Connection) KeepHeartbeat()
  • func (c *Connection) Open(w http.ResponseWriter, r *http.Request) error
  • func (c *Connection) Receive() (msg *Message, err error)
  • func (c *Connection) Write(msg *Message) (err error)
• type Message
• type Options

Constants

const (
	// TextMessage denotes a text data message. The text message payload is
	// interpreted as UTF-8 encoded text data.
	TextMessage = 1

	// BinaryMessage denotes a binary data message.
	BinaryMessage = 2

	// CloseMessage denotes a close control message. The optional message
	// payload contains a numeric code and text. Use the FormatCloseMessage
	// function to format a close message payload.
	CloseMessage = 8

	// PingMessage denotes a ping control message. The optional message payload
	// is UTF-8 encoded text.
	PingMessage = 9

	// PongMessage denotes a pong control message. The optional message payload
	// is UTF-8 encoded text.
	PongMessage = 10
)

The message types are defined in RFC 6455, section 11.8.

const (
	// DefaultInChanSize 默认读队列大小
	DefaultInChanSize = 1024

	// DefaultOutChanSize 默认写队列大小
	DefaultOutChanSize = 1024

	// DefaultHeartbeatInterval 默认心跳检测间隔
	DefaultHeartbeatInterval = 300
)

Variables

var (
	// ErrConnClose 连接已关闭
	ErrConnClose = errors.New("connection already closed")
)

Types

type Conn

type Conn interface {
	// Close 关闭连接
	Close() error
	// Open 开启连接
	Open(w http.ResponseWriter, r *http.Request) error
	// Receive 接收数据
	Receive() (msg *Message, err error)
	// Write 写入数据
	Write(msg *Message) (err error)
}

Conn 长连接接口

type Connection

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

Connection 维护的长连接.

func NewConnection

func NewConnection(opts ...*Options) *Connection

NewConnection 新建 Connection实例.

func (*Connection) Close

func (c *Connection) Close() error

Close 关闭连接

func (*Connection) GetConnID

func (c *Connection) GetConnID() string

GetConnID 获取连接ID

func (*Connection) GetRemoteAddr

func (c *Connection) GetRemoteAddr() net.Addr

GetRemoteAddr 获取远程地址

func (*Connection) KeepHeartbeat

func (c *Connection) KeepHeartbeat()

KeepHeartbeat 保持心跳

func (*Connection) Open

func (c *Connection) Open(w http.ResponseWriter, r *http.Request) error

Open 开启连接

func (*Connection) Receive

func (c *Connection) Receive() (msg *Message, err error)

Receive 接收数据

func (*Connection) Write

func (c *Connection) Write(msg *Message) (err error)

Write 写入数据

type Message

type Message struct {
	// MessageType The message types are defined in RFC 6455, section 11.8.
	MessageType int
	// Data 消息内容
	Data []byte
}

Message 定义了一个消息实体.

type Options

type Options struct {
	// InChanSize 读队列大小, 默认1024
	InChanSize int
	// OutChanSize 写队列大小, 默认1024
	OutChanSize int
	// HeartbeatInterval 心跳检测间隔, 当心跳间隔大于这个时间连接将断开, 默认300s
	HeartbeatInterval int
}

Options 可选参数