websockets

Documentation

Overview

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

Index

• Variables
• func EncodeMessage(typ MessageType, msg interface{}) ([]byte, error)
• func Handler(res http.ResponseWriter, req *http.Request)
• func Listen() error
• func UpdatePost(id int64, key string, val interface{}, msg []byte) error
• type Client
  • func (c *Client) Close(err error)
  • func (c *Client) Send(msg []byte)
• type ClientMap
  • func (c *ClientMap) Clear()
  • func (c *ClientMap) CountByIP() int
  • func (c *ClientMap) GetSync(cl *Client) (bool, SyncID)
• type MessageType
• type SyncID

Variables

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

Clients stores all synchronized websocket clients in a thread-safe map

Functions

func EncodeMessage

func EncodeMessage(typ MessageType, msg interface{}) ([]byte, error)

EncodeMessage encodes a message for sending through websockets or writing to the replication log.

func Handler

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

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

func Listen

func Listen() error

Listen initializes and starts listening for post updates from RethinkDB

func UpdatePost

func UpdatePost(id int64, key string, val interface{}, msg []byte) error

UpdatePost post updates a single field of an existing post with the appropriate replication log update and timestamp modification.

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(err error)

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

func (*Client) Send

func (c *Client) Send(msg []byte)

Send a message to the client. Can be used concurrently.

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) 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 synchronized 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.

type MessageType

type MessageType uint8

MessageType is the identifier code for websocket message types

const (
	MessageInvalid MessageType = iota
	MessageInsertThread
	MessageInsertPost
	MessageAppend
	MessageBackspace
	MessageSplice
	MessageClosePost
	MessageLink
	MessageBacklink
	MessageCommand
	MessageInsertImage
	MessageSpoiler
	MessageDelete
)

1 - 29 modify post model state

const (
	// Update feeds
	MessageSynchronise MessageType = 30 + iota
	MessageReclaim

	// Account management
	MessageRegister
	MessageLogin
	MessageAuthenticate
	MessageLogout
	MessageLogOutAll
	MessageChangePassword

	// Board administration
	MessageConfigServer
	MessageCreateBoard

	// Send new post ID to client
	MessagePostID

	// Concatenation of multiple websocket messages to reduce transport overhead
	MessageConcat

	// Message from the client meant to invoke no operation. Mostly used as a
	// one way ping, because the JS Websocket API does not provide access to
	// pinging.
	MessageNOOP
)

>= 30 are miscellaneous and do not write to post models

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.