websocket

Documentation

Index

• Constants
• func AddAction(name string, action Action)
• func Handle(w http.ResponseWriter, r *http.Request)
• func SendUpdate()
• type Action
• type Connection
• type ID

Constants

const (
	//JSONComunication is the constant that indicates a JSON sommunication
	JSONComunication = "JSON"
)

Functions

func AddAction

func AddAction(name string, action Action)

AddAction adds an action to a map of actions, overwrites already set functions

func Handle

func Handle(w http.ResponseWriter, r *http.Request)

Handle handles the websocket connection

func SendUpdate

func SendUpdate()

SendUpdate sends an update request to all the WS clients

Types

type Action

type Action func() error

Action is an action activatable by WS connections

type Connection

type Connection struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

Connection is the type used to represent a connection

type ID

type ID [letterIdxMax]byte

ID is the ID type used for websocket connections