websockutil

Documentation

Index

• type Options
  • func (o *Options) FillDefaults()
  • func (o *Options) Upgrader() websocket.Upgrader
• type ReceiverFunc
• type Session
  • func (s *Session) Close()
  • func (s *Session) Done() <-chan struct{}
  • func (s *Session) Shutdown()
  • func (s *Session) WriteLoop()
  • func (s *Session) WriteMsg(kind int, data []byte) error
• type SessionFactory
  • func NewSessionFactory(o Options) *SessionFactory
  • func (f *SessionFactory) NewSession(w http.ResponseWriter, req *http.Request, log *slog.Logger, recv ReceiverFunc) (*Session, error)

Types

type Options

type Options struct {
	ReadSize      int           `toml:"read-size"`
	WriteSize     int           `toml:"write-size"`
	WriteDeadline time.Duration `toml:"write-deadline"`
	PingInterval  time.Duration `toml:"ping-interval"`
	PingTimeout   time.Duration `toml:"ping-timeout"`
	ReadMsgLimit  int64         `toml:"read-msg-limit"`
}

func (*Options) FillDefaults

func (o *Options) FillDefaults()

func (*Options) Upgrader

func (o *Options) Upgrader() websocket.Upgrader

type ReceiverFunc

type ReceiverFunc func(msg []byte) error

type Session

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

func (*Session) Close

func (s *Session) Close()

func (*Session) Done

func (s *Session) Done() <-chan struct{}

func (*Session) Shutdown

func (s *Session) Shutdown()

func (*Session) WriteLoop

func (s *Session) WriteLoop()

func (*Session) WriteMsg

func (s *Session) WriteMsg(kind int, data []byte) error

type SessionFactory

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

func NewSessionFactory

func NewSessionFactory(o Options) *SessionFactory

func (*SessionFactory) NewSession

func (f *SessionFactory) NewSession(
	w http.ResponseWriter,
	req *http.Request,
	log *slog.Logger,
	recv ReceiverFunc,
) (*Session, error)