web

Documentation

Index

• Constants
• Variables
• type EventPayload
• type Message
• type MessageGeneric
• type MessageHandler
• type UserInfo
• type WsClient
  • func NewClient(conn net.Conn, hub *WsHub) *WsClient
  • func (wc *WsClient) String() string
• type WsHub
  • func NewHub(gb *gloomberg.Gloomberg) *WsHub
  • func StartWebUI(gb *gloomberg.Gloomberg) (*WsHub, error)
  • func (wh *WsHub) ClientsOnline() uint64

Constants

const (
	MsgNewSale         = "new_event"
	MsgGasPrice        = "gas_price"
	MsgRecentOwnEvents = "recent_own_events"

	MsgCommand = "cmd"
)

Variables

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

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

Types

type EventPayload

type EventPayload struct {
	Message string `json:"message"`
}

payloads for message types.

type Message

type Message struct {
	// Type is the message type sent
	Type string `json:"type"`

	// Payload is the data Based on the Type
	Payload *json.RawMessage `json:"payload"`
}

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

type MessageGeneric

type MessageGeneric[T interface{}] struct {
	// Type is the message type sent
	Type string `json:"type"`

	// Payload is the data Based on the Type
	Payload T `json:"payload"`

	// Current Gas Price
	GasPrice uint64 `json:"gas_price"`
}

type MessageHandler

type MessageHandler func(message Message, c *WsClient) error

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

type UserInfo

type UserInfo struct {
	Name    string         `json:"username"`
	Address common.Address `json:"address"`
}

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.

func (*WsClient) String

func (wc *WsClient) String() string

type WsHub

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

func NewHub

func NewHub(gb *gloomberg.Gloomberg) *WsHub

func StartWebUI

func StartWebUI(gb *gloomberg.Gloomberg) (*WsHub, error)

func (*WsHub) ClientsOnline

func (wh *WsHub) ClientsOnline() uint64

ClientsOnline returns the number of clients that are currently connected.