pubsub

Documentation

Index

• type Client
  • func NewClient(hub Pubsuber, conn *websocket.Conn, user *model.User) *Client
  • func (c *Client) Close() error
  • func (c *Client) IsSubscribed(topic string) bool
  • func (c *Client) Start() error
  • func (c *Client) Subscribe(topic string)
  • func (c *Client) User() *model.User
• type Hub
  • func NewHub(tokenSecret []byte, tokenExpire time.Duration, tokenIssuer string, ...) *Hub
  • func (h *Hub) Broadcast(msg Message) error
  • func (h *Hub) Register(c *Client) error
  • func (h *Hub) ServeWs() http.Handler
  • func (h *Hub) Start() error
  • func (h *Hub) Unregister(c *Client) error
• type Message
• type Pubsuber

Types

type Client

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

Client is a middleman between the websocket connection and the hub.

func NewClient

func NewClient(hub Pubsuber, conn *websocket.Conn, user *model.User) *Client

func (*Client) Close

func (c *Client) Close() error

func (*Client) IsSubscribed

func (c *Client) IsSubscribed(topic string) bool

func (*Client) Start

func (c *Client) Start() error

func (*Client) Subscribe

func (c *Client) Subscribe(topic string)

func (*Client) User

func (c *Client) User() *model.User

type Hub

type Hub struct {
	TokenSecret []byte
	TokenExpire time.Duration
	TokenIssuer string
	Users       *store.Users
	// contains filtered or unexported fields
}

func NewHub

func NewHub(tokenSecret []byte, tokenExpire time.Duration, tokenIssuer string, users *store.Users) *Hub

func (*Hub) Broadcast

func (h *Hub) Broadcast(msg Message) error

func (*Hub) Register

func (h *Hub) Register(c *Client) error

func (*Hub) ServeWs

func (h *Hub) ServeWs() http.Handler

func (*Hub) Start

func (h *Hub) Start() error

func (*Hub) Unregister

func (h *Hub) Unregister(c *Client) error

type Message

type Message interface {
	Topic() string
	Data() interface{}
	ShouldSendTo(*Client) bool
}

type Pubsuber

type Pubsuber interface {
	Start() error
	Register(*Client) error
	Unregister(*Client) error
	Broadcast(Message) error
	ServeWs() http.Handler
}