web

Documentation

Index

• Constants
• Variables
• func HandleWs(w http.ResponseWriter, r *http.Request)
• func HandleWsInternal(w http.ResponseWriter, r *http.Request) error
• func MakeTCPListener(serviceName string) (net.Listener, error)
• func MakeUnixListener() (net.Listener, error)
• func ReadLoop(conn *websocket.Conn, outputCh chan any, closeCh chan any, ...)
• func RunWebServer(listener net.Listener)
• func RunWebSocketServer(listener net.Listener)
• func WriteJsonError(w http.ResponseWriter, errVal error)
• func WriteJsonSuccess(w http.ResponseWriter, data interface{})
• func WriteLoop(conn *websocket.Conn, outputCh chan any, closeCh chan any, routeId string)
• func WritePing(conn *websocket.Conn) error
• type ClientActiveState
• type WebFnOpts
• type WebFnType
  • func WebFnWrap(opts WebFnOpts, fn WebFnType) WebFnType

Constants

const (
	CacheControlHeaderKey     = "Cache-Control"
	CacheControlHeaderNoCache = "no-cache"

	ContentTypeHeaderKey = "Content-Type"
	ContentTypeJson      = "application/json"
	ContentTypeBinary    = "application/octet-stream"

	ContentLengthHeaderKey = "Content-Length"
	LastModifiedHeaderKey  = "Last-Modified"

	WaveZoneFileInfoHeaderKey = "X-ZoneFileInfo"
)

Header constants

const DefaultCommandTimeout = 2 * time.Second

const HttpMaxHeaderBytes = 60000

const HttpReadTimeout = 5 * time.Second

const HttpTimeoutDuration = 21 * time.Second

const HttpWriteTimeout = 21 * time.Second

const TransparentGif64 = "R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"

const WSStatePacketChSize = 20

const WSStateReconnectTime = 30 * time.Second

Variables

var WebSocketUpgrader = websocket.Upgrader{
	ReadBufferSize:   4 * 1024,
	WriteBufferSize:  32 * 1024,
	HandshakeTimeout: 1 * time.Second,
	CheckOrigin:      func(r *http.Request) bool { return true },
}

Functions

func HandleWs

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

func HandleWsInternal

func HandleWsInternal(w http.ResponseWriter, r *http.Request) error

func MakeTCPListener

func MakeTCPListener(serviceName string) (net.Listener, error)

func MakeUnixListener

func MakeUnixListener() (net.Listener, error)

func ReadLoop

func ReadLoop(conn *websocket.Conn, outputCh chan any, closeCh chan any, rpcInputCh chan []byte, routeId string)

func RunWebServer

func RunWebServer(listener net.Listener)

blocking

func RunWebSocketServer

func RunWebSocketServer(listener net.Listener)

func WriteJsonError

func WriteJsonError(w http.ResponseWriter, errVal error)

func WriteJsonSuccess

func WriteJsonSuccess(w http.ResponseWriter, data interface{})

func WriteLoop

func WriteLoop(conn *websocket.Conn, outputCh chan any, closeCh chan any, routeId string)

func WritePing

func WritePing(conn *websocket.Conn) error

Types

type ClientActiveState

type ClientActiveState struct {
	Fg     bool `json:"fg"`
	Active bool `json:"active"`
	Open   bool `json:"open"`
}

type WebFnOpts

type WebFnOpts struct {
	AllowCaching bool
	JsonErrors   bool
}

type WebFnType

type WebFnType = func(http.ResponseWriter, *http.Request)

func WebFnWrap

func WebFnWrap(opts WebFnOpts, fn WebFnType) WebFnType