websocket

package

v1.0.0-websocket-base Latest Latest Go to latest Published: Aug 3, 2024 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gin-generator/ginctl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func EventListener(interval time.Duration, eventFunc func(), stopChan <-chan struct{})
func NewClientManager()
func Register(event string, handler DisposeFunc)
func Upgrade(w http.ResponseWriter, req *http.Request)
type Client
- func NewClient(addr string, socket *websocket.Conn) *Client
- func (c *Client) Close()
- func (c *Client) CloseSubscribe(channel string) (err error)
- func (c *Client) CreatChan() (channel string, err error)
- func (c *Client) GetAllChan() (channels []string, pubSubs []*redis.PubSub)
- func (c *Client) GetChan(channel string) (pubSub *redis.PubSub, err error)
- func (c *Client) Heartbeat()
- func (c *Client) IsHeartbeatTimeout(currentTime int64) (timeout bool)
- func (c *Client) Publish(channel string, message []byte) (err error)
- func (c *Client) Read()
- func (c *Client) Receive()
- func (c *Client) SendMessage(message []byte)
- func (c *Client) SetHeartbeatTime(currentTime int64)
- func (c *Client) Subscribe(channel string) (err error)
- func (c *Client) Unsubscribe(channel string) (err error)
- func (c *Client) Write()
type ClientManager
- func (m *ClientManager) Close(client *Client)
- func (m *ClientManager) GetAllClient() (clients []*Client)
- func (m *ClientManager) GetClient(fd string) (client *Client, err error)
- func (m *ClientManager) RegisterClient(client *Client)
- func (m *ClientManager) Scheduler()
type DisposeFunc
- func GetHandler(event string) (handler DisposeFunc, err error)
type DistributeHandler
type JsonHandler
- func NewJsonHandler() *JsonHandler
- func (j *JsonHandler) Distribute(client *Client, message []byte) (err error)
- func (j *JsonHandler) Do(client *Client, response *Response) (err error)
type Message
type Middleware
type ProtoHandler
- func NewProtoHandler() *ProtoHandler
- func (p *ProtoHandler) Distribute(client *Client, message []byte) (err error)
- func (p *ProtoHandler) Do(client *Client, response *pb.Response) (err error)
type Request
type Response

Constants ¶

View Source

const (
	Max = 1000
)

Variables ¶

This section is empty.

Functions ¶

func EventListener ¶

func EventListener(interval time.Duration, eventFunc func(), stopChan <-chan struct{})

func NewClientManager ¶

func NewClientManager()

func Register ¶

func Register(event string, handler DisposeFunc)

Register event to memory

func Upgrade ¶

func Upgrade(w http.ResponseWriter, req *http.Request)

Types ¶

type Client ¶

type Client struct {
	Fd           string          // 每个连接唯一标识
	Addr         string          // 客户端ip地址
	Socket       *websocket.Conn // 用户连接
	Send         chan []byte     // 待发送的数据
	Channel      sync.Map        // 订阅频道
	OwnerChannel sync.Map        // 自己创建的频道

	FirstTime     int64 // 首次连接事件
	HeartbeatTime int64 // 用户上次心跳时间
	Timeout       int64 // 超时断连时间
	Protocol      int   // 协议类型
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(addr string, socket *websocket.Conn) *Client

func (*Client) Close ¶

func (c *Client) Close()

func (*Client) CloseSubscribe ¶

func (c *Client) CloseSubscribe(channel string) (err error)

func (*Client) CreatChan ¶

func (c *Client) CreatChan() (channel string, err error)

CreatChan Creat channel

func (*Client) GetAllChan ¶

func (c *Client) GetAllChan() (channels []string, pubSubs []*redis.PubSub)

GetAllChan Get all channels

func (*Client) GetChan ¶

func (c *Client) GetChan(channel string) (pubSub *redis.PubSub, err error)

GetChan Get channel

func (*Client) Heartbeat ¶

func (c *Client) Heartbeat()

Heartbeat The scheduled task clears timeout links

func (*Client) IsHeartbeatTimeout ¶

func (c *Client) IsHeartbeatTimeout(currentTime int64) (timeout bool)

func (*Client) Publish ¶

func (c *Client) Publish(channel string, message []byte) (err error)

Publish a message

func (*Client) Read ¶

func (c *Client) Read()

Read client data

func (*Client) Receive ¶

func (c *Client) Receive()

Receive subscription messages

func (*Client) SendMessage ¶

func (c *Client) SendMessage(message []byte)

SendMessage Message distribution

func (*Client) SetHeartbeatTime ¶

func (c *Client) SetHeartbeatTime(currentTime int64)

func (c *Client) Subscribe(channel string) (err error)

Subscribe to messages for long links

func (*Client) Unsubscribe ¶

func (c *Client) Unsubscribe(channel string) (err error)

Unsubscribe unsubscribe

func (*Client) Write ¶

func (c *Client) Write()

Write Send data to the client

type ClientManager ¶

type ClientManager struct {
	Pool      sync.Map
	Register  chan *Client
	Unset     chan *Client
	Total     uint
	Max       uint
	Broadcast chan []byte
	Errs      chan error
}

ClientManager Client pool manager

var (
	Manager *ClientManager
)

func (*ClientManager) Close ¶

func (m *ClientManager) Close(client *Client)

Close Unset client

func (*ClientManager) GetAllClient ¶

func (m *ClientManager) GetAllClient() (clients []*Client)

GetAllClient Get all client

func (*ClientManager) GetClient ¶

func (m *ClientManager) GetClient(fd string) (client *Client, err error)

GetClient Obtain the client according to fd

func (*ClientManager) RegisterClient ¶

func (m *ClientManager) RegisterClient(client *Client)

RegisterClient Register client

func (*ClientManager) Scheduler ¶

func (m *ClientManager) Scheduler()

Scheduler Start the websocket scheduler

type DisposeFunc ¶

type DisposeFunc func(request *Request) (response *Response)

func GetHandler ¶

func GetHandler(event string) (handler DisposeFunc, err error)

GetHandler Get register's func

type DistributeHandler ¶

type DistributeHandler interface {
	Distribute(client *Client, message []byte) (err error)
}

type JsonHandler ¶

type JsonHandler struct{}

func NewJsonHandler ¶

func NewJsonHandler() *JsonHandler

func (*JsonHandler) Distribute ¶

func (j *JsonHandler) Distribute(client *Client, message []byte) (err error)

func (*JsonHandler) Do ¶

func (j *JsonHandler) Do(client *Client, response *Response) (err error)

type Message ¶

type Message struct {
	Event   string `json:"event" validate:"required"`
	Request string `json:"request"`
}

type Middleware ¶

type Middleware func(next http.HandlerFunc) http.HandlerFunc

type ProtoHandler ¶

type ProtoHandler struct{}

func NewProtoHandler ¶

func NewProtoHandler() *ProtoHandler

func (*ProtoHandler) Distribute ¶

func (p *ProtoHandler) Distribute(client *Client, message []byte) (err error)

func (*ProtoHandler) Do ¶

func (p *ProtoHandler) Do(client *Client, response *pb.Response) (err error)

type Request ¶

type Request struct {
	Client *Client
	Send   []byte
}

type Response ¶

type Response struct {
	Code    uint32 `json:"code"`
	Message string `json:"message"`
	Content string `json:"content"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
pb

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL