web

Documentation

Index

• type B
• type Ctx
• type E
• type N
• type S
• type Socket
  • func NewSocket(conn *websocket.Conn, req *http.Request, challenge B) (ws *Socket)
  • func (ws *Socket) AuthRequested() bool
  • func (ws *Socket) Authed() S
  • func (ws *Socket) AuthedBytes() B
  • func (ws *Socket) Challenge() S
  • func (ws *Socket) IsAuthed() bool
  • func (ws *Socket) Limiter() *rate.Limiter
  • func (ws *Socket) RealRemote() S
  • func (ws *Socket) Req() *http.Request
  • func (ws *Socket) RequestAuth()
  • func (ws *Socket) SetAuthed(s S)
  • func (ws *Socket) SetLimiter(l *rate.Limiter)
  • func (ws *Socket) Write(p []byte) (n int, err error)
  • func (ws *Socket) WriteJSON(any interface{}) E
  • func (ws *Socket) WriteMessage(t int, b B) E

Types

type B

type B = []byte

type Ctx

type Ctx = context.T

type E

type E = error

type N

type N = int

type S

type S = string

type Socket

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

func NewSocket

func NewSocket(
	conn *websocket.Conn,
	req *http.Request,
	challenge B,
) (ws *Socket)

func (*Socket) AuthRequested

func (ws *Socket) AuthRequested() bool

func (*Socket) Authed

func (ws *Socket) Authed() S

func (*Socket) AuthedBytes

func (ws *Socket) AuthedBytes() B

func (*Socket) Challenge

func (ws *Socket) Challenge() S

func (*Socket) IsAuthed

func (ws *Socket) IsAuthed() bool

func (*Socket) Limiter

func (ws *Socket) Limiter() *rate.Limiter

func (*Socket) RealRemote

func (ws *Socket) RealRemote() S

func (*Socket) Req

func (ws *Socket) Req() *http.Request

func (*Socket) RequestAuth

func (ws *Socket) RequestAuth()

func (*Socket) SetAuthed

func (ws *Socket) SetAuthed(s S)

func (*Socket) SetLimiter

func (ws *Socket) SetLimiter(l *rate.Limiter)

func (*Socket) Write

func (ws *Socket) Write(p []byte) (n int, err error)

func (*Socket) WriteJSON

func (ws *Socket) WriteJSON(any interface{}) E

func (*Socket) WriteMessage

func (ws *Socket) WriteMessage(t int, b B) E