ws

Documentation

Index

• func ErrorToHttpCode(err error) int
• func SendJsonResponse(writer http.ResponseWriter, resp interface{}, err error)
• func WSConnJSONReaderWriter(conn *websocket.Conn) (reader *conc.Reader[gut.StringMap], ...)
• func WSConnWriteError(wsConn *websocket.Conn, err error) error
• func WSConnWriteMessage(wsConn *websocket.Conn, msg interface{}) error
• func WSHandleConn[I any, S WSConn[I]](conn *websocket.Conn, ctx S, config *WSConnConfig)
• func WSServe[I any, S WSConn[I]](h WSHandler[I, S], config *WSConnConfig) http.HandlerFunc
• type BiDirStreamConfig
  • func DefaultBiDirStreamConfig() *BiDirStreamConfig
• type BiDirStreamConn
• type JSONConn
  • func (j *JSONConn) ConnId() string
  • func (j *JSONConn) DebugInfo() any
  • func (j *JSONConn) HandleMessage(msg any) error
  • func (j *JSONConn) Name() string
  • func (j *JSONConn) OnClose()
  • func (j *JSONConn) OnError(err error) error
  • func (j *JSONConn) OnStart(conn *websocket.Conn) error
  • func (j *JSONConn) OnTimeout() bool
  • func (j *JSONConn) ReadMessage(conn *websocket.Conn) (out any, err error)
  • func (j *JSONConn) SendPing() error
• type JSONHandler
  • func (j *JSONHandler) Validate(w http.ResponseWriter, r *http.Request) (out WSConn[any], isValid bool)
• type WSConn
• type WSConnConfig
  • func DefaultWSConnConfig() *WSConnConfig
• type WSHandler

Functions

func ErrorToHttpCode

func ErrorToHttpCode(err error) int

func SendJsonResponse

func SendJsonResponse(writer http.ResponseWriter, resp interface{}, err error)

func WSConnJSONReaderWriter

func WSConnJSONReaderWriter(conn *websocket.Conn) (reader *conc.Reader[gut.StringMap], writer *conc.Writer[conc.Message[gut.StringMap]])

func WSConnWriteError

func WSConnWriteError(wsConn *websocket.Conn, err error) error

func WSConnWriteMessage

func WSConnWriteMessage(wsConn *websocket.Conn, msg interface{}) error

func WSHandleConn

func WSHandleConn[I any, S WSConn[I]](conn *websocket.Conn, ctx S, config *WSConnConfig)

func WSServe

func WSServe[I any, S WSConn[I]](h WSHandler[I, S], config *WSConnConfig) http.HandlerFunc

Types

type BiDirStreamConfig

type BiDirStreamConfig struct {
	PingPeriod time.Duration
	PongPeriod time.Duration
}

func DefaultBiDirStreamConfig

func DefaultBiDirStreamConfig() *BiDirStreamConfig

type BiDirStreamConn

type BiDirStreamConn[I any] interface {
	/**
	 * Called to send the next ping message.
	 */
	SendPing() error

	// Optional Name of the connection
	Name() string

	// Optional connection id
	ConnId() string

	/**
	 * Called to handle the next message from the input stream on the ws conn.
	 */
	HandleMessage(msg I) error

	/**
	 * Called to handle or suppress an error
	 */
	OnError(err error) error

	/**
	 * Called when the connection closes.
	 */
	OnClose()
	OnTimeout() bool
}

type JSONConn

type JSONConn struct {
	Writer    *conc.Writer[conc.Message[any]]
	NameStr   string
	ConnIdStr string
	PingId    int64
}

func (*JSONConn) ConnId

func (j *JSONConn) ConnId() string

func (*JSONConn) DebugInfo

func (j *JSONConn) DebugInfo() any

func (*JSONConn) HandleMessage

func (j *JSONConn) HandleMessage(msg any) error

*

• Called to handle the next message from the input stream on the ws conn.

func (*JSONConn) Name

func (j *JSONConn) Name() string

func (*JSONConn) OnClose

func (j *JSONConn) OnClose()

*

• Called when the connection closes.

func (*JSONConn) OnError

func (j *JSONConn) OnError(err error) error

func (*JSONConn) OnStart

func (j *JSONConn) OnStart(conn *websocket.Conn) error

func (*JSONConn) OnTimeout

func (j *JSONConn) OnTimeout() bool

func (*JSONConn) ReadMessage

func (j *JSONConn) ReadMessage(conn *websocket.Conn) (out any, err error)

*

• Reads the next message from the ws conn.

func (*JSONConn) SendPing

func (j *JSONConn) SendPing() error

*

• Called to send the next ping message.

type JSONHandler

type JSONHandler struct {
}

func (*JSONHandler) Validate

func (j *JSONHandler) Validate(w http.ResponseWriter, r *http.Request) (out WSConn[any], isValid bool)

type WSConn

type WSConn[I any] interface {
	BiDirStreamConn[I]
	/**
	 * Reads the next message from the ws conn.
	 */
	ReadMessage(w *websocket.Conn) (I, error)
	/**
	 * On created.
	 */
	OnStart(conn *websocket.Conn) error
}

type WSConnConfig

type WSConnConfig struct {
	*BiDirStreamConfig
	Upgrader websocket.Upgrader
}

func DefaultWSConnConfig

func DefaultWSConnConfig() *WSConnConfig

type WSHandler

type WSHandler[I any, S WSConn[I]] interface {
	/**
	 * Called to validate an http request to see if it is upgradeable to a ws conn
	 */
	Validate(w http.ResponseWriter, r *http.Request) (S, bool)
}