hub

Documentation

Index

• type Client
• type Hub
  • func New(workerPoolSize int) (*Hub, error)
  • func (h *Hub) Close()
  • func (h *Hub) Register(c Client)
  • func (h *Hub) Run()
  • func (h *Hub) SendEvent(e *event.Event)
  • func (h *Hub) Subscribe(e SubscribeEvent)
  • func (h *Hub) UnRegister(c Client)
  • func (h *Hub) Unsubscribe(e UnsubscribeEvent)
• type SubscribeEvent
• type UnsubscribeEvent

Types

type Client

type Client interface {
	// ID returns a client id
	ID() uint64

	// OnClose sets a close handler
	OnClose(h func())

	// OnSubscribe sets a subscribing handler
	OnSubscribe(h func(params []string))

	// OnSubscribe sets a unsubscribing handler
	OnUnsubscribe(h func(params []string))

	// Send sends a message to the client
	Send(msg []byte)
}

Client represents a contract for websocket client

type Hub

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

Hub maintains a set of active clients

func New

func New(workerPoolSize int) (*Hub, error)

New creates a new hub

func (*Hub) Close

func (h *Hub) Close()

Close closes a hub (not thread safe)

func (*Hub) Register

func (h *Hub) Register(c Client)

Register registers a client to the hub

func (*Hub) Run

func (h *Hub) Run()

Run runs worker to manage clients

func (*Hub) SendEvent

func (h *Hub) SendEvent(e *event.Event)

SendEvent sends an event to clients

func (*Hub) Subscribe

func (h *Hub) Subscribe(e SubscribeEvent)

Subscribe handle subscribing

func (*Hub) UnRegister

func (h *Hub) UnRegister(c Client)

UnRegister unregisters a client from the hub

func (*Hub) Unsubscribe

func (h *Hub) Unsubscribe(e UnsubscribeEvent)

Unsubscribe handle unsubscribing

type SubscribeEvent

type SubscribeEvent struct {
	ClientID uint64
	Types    []string
}

SubscribeEvent is a subscription detail

type UnsubscribeEvent

type UnsubscribeEvent struct {
	ClientID uint64
	Types    []string
}

UnsubscribeEvent is a unsubscription detail