web

Documentation

Index

• Constants
• Variables
• func StartWebUI(queueWsOutTokenTransactions chan *totra.TokenTransaction)
• type Event
• type EventHandler
• type SendMessageEvent
• type WsClient
  • func NewClient(conn net.Conn, hub *WsHub) *WsClient
• type WsHub
  • func NewHub(queueWsOutTokenTransactions chan *totra.TokenTransaction) *WsHub

Constants

const (
	// EventSendMessage is the event name for new chat messages sent
	EventSendMessage = "send_message"
)

Variables

var (
	ErrEventNotSupported = errors.New("this event type is not supported")
)

* wsUpgrader is used to upgrade incomming HTTP requests into a persitent websocket connection

Functions

func StartWebUI

func StartWebUI(queueWsOutTokenTransactions chan *totra.TokenTransaction)

Types

type Event

type Event struct {
	// Type is the message type sent
	Type string `json:"type"`
	// Payload is the data Based on the Type
	Payload json.RawMessage `json:"payload"`
}

Event is the Messages sent over the websocket Used to differ between different actions

type EventHandler

type EventHandler func(event Event, c *WsClient) error

EventHandler is a function signature that is used to affect messages on the socket and triggered depending on the type

type SendMessageEvent

type SendMessageEvent struct {
	Message string `json:"message"`
	From    string `json:"from"`
}

SendMessageEvent is the payload sent in the send_message event

type WsClient

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

func NewClient

func NewClient(conn net.Conn, hub *WsHub) *WsClient

NewClient is used to initialize a new Client with all required values initialized

type WsHub

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

func NewHub

func NewHub(queueWsOutTokenTransactions chan *totra.TokenTransaction) *WsHub