handlers

Documentation

Index

• func Home(w http.ResponseWriter, r *http.Request)
• func ListenForWs(conn *WebSocketConnection)
• func ListenToWsChannel()
• func WsEndpoint(w http.ResponseWriter, r *http.Request)
• type WebSocketConnection
• type WsJsonResponse
• type WsPayload

Functions

func Home

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

Home renders the home page 1. Somebody connects to the webpage: func Home <- display the webpage

func ListenForWs

func ListenForWs(conn *WebSocketConnection)

Goroutine to listen for messages from the websocket 3. When we connect to WS:

1. go ListenForWs(&conn) <- is called
2. go ListenForWs(&conn) <- is a goroutine on a infite loop
3. wsChan <- payload <- everything sent on the payload is pass to wsChan

func ListenToWsChannel

func ListenToWsChannel()

4. Everything on the the payload is store on the variable e func ListenToWsChannel() <- everything on the the payload is store on the variable e
1. Here is where we process the payload, the logic, where we stract the username or the message.

func WsEndpoint

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

WsEndpoint upgrades connection to websocket 2. func WsEndpoint is called to connect the WS

Types

type WebSocketConnection

type WebSocketConnection struct {
	*websocket.Conn
}

type WsJsonResponse

type WsJsonResponse struct {
	Action         string   `json:"action"`
	Message        string   `json:"message"`
	MessageType    string   `json:"message_type"`
	ConnectedUsers []string `json:"connected_users"`
}

WsJsonResponse defines the response sent back from websocket

type WsPayload

type WsPayload struct {
	Action   string              `json:"action"`
	Username string              `json:"username"`
	Message  string              `json:"message"`
	Conn     WebSocketConnection `json:"-"`
}

WsPayload defines the websocket request from the client