websocket

README

WebSocket Manager for Go

中文

A lightweight WebSocket manager for Go, built with gin-gonic and gorilla/websocket. This library provides a robust WebSocket server implementation with features like connection management, message routing, and validation.

Features

• WebSocket Management: Handle multiple WebSocket connections with ease.
• Message Routing: Route messages based on custom protocols.
• Validation: Built-in support for struct validation using go-playground/validator.
• Heartbeat Detection: Automatically detect and close inactive connections.
• Customizable: Easily extend and customize the library for your needs.

Installation

To install the library, use go get:

go get -u github.com/gin-generator/websocket

Examples

You can find usage examples in the example folder.

• Basic WebSocket Server: Demonstrates how to handle WebSocket connections and messages.

Documentation

Index

• Constants
• Variables
• func Connect(opts ...Option) gin.HandlerFunc
• func NewManagerWithOptions(opts ...ManagerOption)
• func ValidateStructWithOutCtx(s interface{}) (err error)
• type Client
  • func NewClientWithOptions(conn *websocket.Conn, opts ...Option) *Client
  • func (c *Client) Close()
  • func (c *Client) Deadline() (deadline time.Time, ok bool)
  • func (c *Client) Done() <-chan struct{}
  • func (c *Client) Err() error
  • func (c *Client) Heartbeat()
  • func (c *Client) Read()
  • func (c *Client) SendMessage(message Send)
  • func (c *Client) SetValue(key, value any)
  • func (c *Client) Value(key any) any
  • func (c *Client) Write()
• type CommandRouter
  • func NewCommandRouter() *CommandRouter
  • func (r *CommandRouter) ProtoHandle(client *Client, send Send) (err error)
  • func (r *CommandRouter) RegisterProto(command string, handler func(*m.Message))
  • func (r *CommandRouter) RegisterText(command string, handler func(*Message))
  • func (r *CommandRouter) TextHandle(client *Client, send Send) (err error)
• type JSONSerializer
  • func NewJSONSerializer[T Message](data T) *JSONSerializer[T]
  • func (j *JSONSerializer[T]) Data() T
  • func (j *JSONSerializer[T]) Deserialize(data []byte, v *T) error
  • func (j *JSONSerializer[T]) Serialize(data T) ([]byte, error)
• type Manager
  • func (m *Manager) GetAllClient() (pool map[string]*Client)
  • func (m *Manager) GetClient(id string) (client *Client, err error)
  • func (m *Manager) SendBroadcast(message Send)
• type ManagerOption
  • func WithMaxConn(maxConn uint32) ManagerOption
  • func WithReadBufferSize(size int) ManagerOption
  • func WithRegisterLimit(registerLimit int) ManagerOption
  • func WithWriteBufferSize(size int) ManagerOption
• type Message
• type Option
  • func WithBreakTime(breakTime int64) Option
  • func WithClientValues(values map[any]any) Option
  • func WithInterval(interval int64) Option
  • func WithSendLimit(sendLimit int) Option
• type ProtoHandler
• type ProtocolSerializer
  • func NewProtocolSerializer[T proto.Message](data T) *ProtocolSerializer[T]
  • func (p *ProtocolSerializer[T]) Data() T
  • func (p *ProtocolSerializer[T]) Deserialize(data []byte, v *T) error
  • func (p *ProtocolSerializer[T]) Serialize(data T) ([]byte, error)
• type Send
• type Serializer
• type TextHandler

Constants

const (
	SendLimit = 100
	BreakTime = 600  // Heartbeat breakTime in seconds
	Interval  = 1000 // Heartbeat interval in milliseconds
)

const (
	RegisterLimit   = 1000
	ReadBufferSize  = 4096
	WriteBufferSize = 4096
	MaxConnections  = 100000
)

Variables

var (
	Once sync.Once
)

Functions

func Connect

func Connect(opts ...Option) gin.HandlerFunc

func NewManagerWithOptions

func NewManagerWithOptions(opts ...ManagerOption)

func ValidateStructWithOutCtx

func ValidateStructWithOutCtx(s interface{}) (err error)

ValidateStructWithOutCtx check struct

Types

type Client

type Client struct {
	context.Context
	// contains filtered or unexported fields
}

func NewClientWithOptions

func NewClientWithOptions(conn *websocket.Conn, opts ...Option) *Client

func (*Client) Close

func (c *Client) Close()

Close logout

func (*Client) Deadline

func (c *Client) Deadline() (deadline time.Time, ok bool)

Deadline SetDeadline Set the deadline

func (*Client) Done

func (c *Client) Done() <-chan struct{}

Done returns a channel that is closed when the context is done.

func (*Client) Err

func (c *Client) Err() error

Err returns a non-nil error value after the context is done.

func (*Client) Heartbeat

func (c *Client) Heartbeat()

Heartbeat detection

func (*Client) Read

func (c *Client) Read()

Read message

func (*Client) SendMessage

func (c *Client) SendMessage(message Send)

SendMessage Send message

func (*Client) SetValue

func (c *Client) SetValue(key, value any)

SetValue sets the value associated with key in the context.

func (*Client) Value

func (c *Client) Value(key any) any

Value returns the value associated with key in the context, if any.

func (*Client) Write

func (c *Client) Write()

Write Send message

type CommandRouter

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

var Router *CommandRouter

func NewCommandRouter

func NewCommandRouter() *CommandRouter

func (*CommandRouter) ProtoHandle

func (r *CommandRouter) ProtoHandle(client *Client, send Send) (err error)

func (*CommandRouter) RegisterProto

func (r *CommandRouter) RegisterProto(command string, handler func(*m.Message))

func (*CommandRouter) RegisterText

func (r *CommandRouter) RegisterText(command string, handler func(*Message))

func (*CommandRouter) TextHandle

func (r *CommandRouter) TextHandle(client *Client, send Send) (err error)

type JSONSerializer

type JSONSerializer[T Message] struct {
	// contains filtered or unexported fields
}

func NewJSONSerializer

func NewJSONSerializer[T Message](data T) *JSONSerializer[T]

func (*JSONSerializer[T]) Data

func (j *JSONSerializer[T]) Data() T

func (*JSONSerializer[T]) Deserialize

func (j *JSONSerializer[T]) Deserialize(data []byte, v *T) error

func (*JSONSerializer[T]) Serialize

func (j *JSONSerializer[T]) Serialize(data T) ([]byte, error)

type Manager

type Manager struct {
	Register        chan *Client
	Unset           chan *Client
	MaxConn         uint32
	ReadBufferSize  int
	WriteBufferSize int
	Errs            chan error
	// contains filtered or unexported fields
}

func (*Manager) GetAllClient

func (m *Manager) GetAllClient() (pool map[string]*Client)

GetAllClient Get all clients

func (*Manager) GetClient

func (m *Manager) GetClient(id string) (client *Client, err error)

GetClient Get client by id

func (*Manager) SendBroadcast

func (m *Manager) SendBroadcast(message Send)

SendBroadcast Send broadcast message

type ManagerOption

type ManagerOption interface {
	// contains filtered or unexported methods
}

func WithMaxConn

func WithMaxConn(maxConn uint32) ManagerOption

func WithReadBufferSize

func WithReadBufferSize(size int) ManagerOption

func WithRegisterLimit

func WithRegisterLimit(registerLimit int) ManagerOption

func WithWriteBufferSize

func WithWriteBufferSize(size int) ManagerOption

type Message

type Message struct {
	RequestId string `json:"request_id" validate:"required"`
	Command   string `json:"command" validate:"required"`
	Code      int32  `json:"code,omitempty"`
	Message   string `json:"message,omitempty"`
	Data      []byte `json:"data,omitempty"`
}

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithBreakTime

func WithBreakTime(breakTime int64) Option

func WithClientValues

func WithClientValues(values map[any]any) Option

func WithInterval

func WithInterval(interval int64) Option

func WithSendLimit

func WithSendLimit(sendLimit int) Option

type ProtoHandler

type ProtoHandler func(message *m.Message)

Handler function type

type ProtocolSerializer

type ProtocolSerializer[T proto.Message] struct {
	// contains filtered or unexported fields
}

func NewProtocolSerializer

func NewProtocolSerializer[T proto.Message](data T) *ProtocolSerializer[T]

func (*ProtocolSerializer[T]) Data

func (p *ProtocolSerializer[T]) Data() T

func (*ProtocolSerializer[T]) Deserialize

func (p *ProtocolSerializer[T]) Deserialize(data []byte, v *T) error

func (*ProtocolSerializer[T]) Serialize

func (p *ProtocolSerializer[T]) Serialize(data T) ([]byte, error)

type Send

type Send struct {
	Protocol int
	Message  []byte
}

type Serializer

type Serializer[T any] interface {
	Serialize(data T) ([]byte, error)
	Deserialize(data []byte, v *T) error
	Data() T
}

type TextHandler

type TextHandler func(message *Message)

Handler function type