websockets

Documentation

Overview

Package websockets manages active websocket connections and messages received from and sent to them.

Index

• Variables
• func CheckOrigin(req *http.Request) bool
• func Handler(res http.ResponseWriter, req *http.Request)
• type Client
  • func (c *Client) Close()
  • func (c *Client) Listen() error
• type ClientMap
  • func (c *ClientMap) Add(cl *Client, syncID SyncID)
  • func (c *ClientMap) ChangeSync(cl *Client, syncID SyncID)
  • func (c *ClientMap) Clear()
  • func (c *ClientMap) CountByIP() int
  • func (c *ClientMap) GetSync(cl *Client) (bool, SyncID)
  • func (c *ClientMap) Remove(cl *Client)
• type SyncID

Variables

var Clients = ClientMap{
	// contains filtered or unexported fields
}

Clients stores all synchronised websocket clients in a theread-safe map

Functions

func CheckOrigin

func CheckOrigin(req *http.Request) bool

CheckOrigin asserts the client matches the origin specified by the server or has none.

func Handler

func Handler(res http.ResponseWriter, req *http.Request)

Handler is an http.HandleFunc that responds to new websocket connection requests.

Types

type Client

type Client struct {

	// Client identity information
	auth.Ident
	// contains filtered or unexported fields
}

Client stores and manages a websocket-connected remote client and its interaction with the server and database

func (*Client) Close

func (c *Client) Close()

Close closes a websocket connection with the provided status code and optional reason

func (*Client) Listen

func (c *Client) Listen() error

Listen listens for incoming messages on the channels and processes them

type ClientMap

type ClientMap struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

ClientMap is a thread-safe store for all clients connected to this server instance

func (*ClientMap) Add

func (c *ClientMap) Add(cl *Client, syncID SyncID)

Add adds a client to the map

func (*ClientMap) ChangeSync

func (c *ClientMap) ChangeSync(cl *Client, syncID SyncID)

ChangeSync changes the thread or board ID the client is synchronised to

func (*ClientMap) Clear

func (c *ClientMap) Clear()

Clear removes all clients from the map

func (*ClientMap) CountByIP

func (c *ClientMap) CountByIP() int

CountByIP returns the number of unique IPs synchronised with the server

func (*ClientMap) GetSync

func (c *ClientMap) GetSync(cl *Client) (bool, SyncID)

GetSync returns if the current client is synced and the thread and board it is synced to.

func (*ClientMap) Remove

func (c *ClientMap) Remove(cl *Client)

Remove removes a client from the map

type SyncID

type SyncID struct {
	OP    int64
	Board string
}

SyncID contains the board and thread the client are currently synced to. If the client is on the board page, thread = 0.