websocket

Documentation

Index

• Variables
• func NewWebSocket(gctx global.Context, conn *websocket.Conn) (client.Connection, error)
• type WebSocket
  • func (*WebSocket) Actor() *structures.User
  • func (w *WebSocket) Buffer() client.EventBuffer
  • func (w *WebSocket) Cache() client.Cache
  • func (w *WebSocket) Context() context.Context
  • func (w *WebSocket) Destroy(gctx global.Context)
  • func (w *WebSocket) Events() *client.EventMap
  • func (w *WebSocket) ForceClose()
  • func (w *WebSocket) Greet(gctx global.Context) error
  • func (w *WebSocket) Handler() client.Handler
  • func (w *WebSocket) OnClose() <-chan struct{}
  • func (w *WebSocket) OnReady() <-chan struct{}
  • func (w *WebSocket) Read(gctx global.Context)
  • func (w *WebSocket) SendAck(cmd events.Opcode, data json.RawMessage) error
  • func (w *WebSocket) SendClose(code events.CloseCode, after time.Duration)
  • func (w *WebSocket) SendError(txt string, fields map[string]any)
  • func (w *WebSocket) SendHeartbeat() error
  • func (w *WebSocket) SessionID() string
  • func (w *WebSocket) SetReady()
  • func (*WebSocket) SetWriter(w *bufio.Writer, f http.Flusher)
  • func (w *WebSocket) Transport() client.Transport
  • func (w *WebSocket) Write(msg events.Message[json.RawMessage]) error

Variables

var ResumableCloseCodes = []int{
	websocket.CloseNormalClosure,
	websocket.CloseGoingAway,
	websocket.CloseAbnormalClosure,
	int(events.CloseCodeTimeout),
	int(events.OpcodeReconnect),
}

Functions

func NewWebSocket

func NewWebSocket(gctx global.Context, conn *websocket.Conn) (client.Connection, error)

Types

type WebSocket

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

func (*WebSocket) Actor

func (*WebSocket) Actor() *structures.User

func (*WebSocket) Buffer

func (w *WebSocket) Buffer() client.EventBuffer

Buffer implements client.Connection

func (*WebSocket) Cache

func (w *WebSocket) Cache() client.Cache

func (*WebSocket) Context

func (w *WebSocket) Context() context.Context

func (*WebSocket) Destroy

func (w *WebSocket) Destroy(gctx global.Context)

func (*WebSocket) Events

func (w *WebSocket) Events() *client.EventMap

func (*WebSocket) ForceClose

func (w *WebSocket) ForceClose()

func (*WebSocket) Greet

func (w *WebSocket) Greet(gctx global.Context) error

func (*WebSocket) Handler

func (w *WebSocket) Handler() client.Handler

func (*WebSocket) OnClose

func (w *WebSocket) OnClose() <-chan struct{}

func (*WebSocket) OnReady

func (w *WebSocket) OnReady() <-chan struct{}

func (*WebSocket) Read

func (w *WebSocket) Read(gctx global.Context)

func (*WebSocket) SendAck

func (w *WebSocket) SendAck(cmd events.Opcode, data json.RawMessage) error

func (*WebSocket) SendClose

func (w *WebSocket) SendClose(code events.CloseCode, after time.Duration)

func (*WebSocket) SendError

func (w *WebSocket) SendError(txt string, fields map[string]any)

SendError implements Connection

func (*WebSocket) SendHeartbeat

func (w *WebSocket) SendHeartbeat() error

func (*WebSocket) SessionID

func (w *WebSocket) SessionID() string

func (*WebSocket) SetReady

func (w *WebSocket) SetReady()

func (*WebSocket) SetWriter

func (*WebSocket) SetWriter(w *bufio.Writer, f http.Flusher)

func (*WebSocket) Transport

func (w *WebSocket) Transport() client.Transport

func (*WebSocket) Write

func (w *WebSocket) Write(msg events.Message[json.RawMessage]) error