gws

Jul 10, 2026

Changes in this version

type Conn

+ func (c *Conn) NextReader() (messageType Opcode, r io.Reader, err error)

Aug 21, 2024

Changes in this version

+ var ErrMessageTooLarge = errors.New("message too large")

Aug 19, 2024

Changes in this version

+ func SetBufferThreshold(x uint32)

type Conn

+ func (c *Conn) WriteFile(opcode Opcode, payload io.Reader) error

Jun 9, 2024

Changes in this version

type ConcurrentMap

+ func (c *ConcurrentMap[K, V]) GetSharding(key K) *Map[K, V]

type Conn

+ func (c *Conn) Async(f func())

Feb 19, 2024

Changes in this version

type SessionStorage

+ Len func() int

Jan 27, 2024

Changes in this version

type ClientOption

+ ParallelEnabled bool

+ ParallelGolimit int

+ PermessageDeflate PermessageDeflate

type Config

+ ParallelEnabled bool

+ ParallelGolimit int

type Conn

+ func (c *Conn) Writev(opcode Opcode, payloads ...[]byte) error

+ func (c *Conn) WritevAsync(opcode Opcode, payloads [][]byte, callback func(error))

+ type PermessageDeflate struct

+ ClientContextTakeover bool

+ ClientMaxWindowBits int

+ Enabled bool

+ Level int

+ PoolSize int

+ ServerContextTakeover bool

+ ServerMaxWindowBits int

+ Threshold int

type Server

+ func (c *Server) GetUpgrader() *Upgrader

type ServerOption

+ ParallelEnabled bool

+ ParallelGolimit int

+ PermessageDeflate PermessageDeflate

type Upgrader

+ func (c *Upgrader) UpgradeFromConn(conn net.Conn, br *bufio.Reader, r *http.Request) (*Conn, error)

Nov 21, 2023

Changes in this version

type ClientOption

+ NewSession func() SessionStorage

type ServerOption

+ NewSession func() SessionStorage

Oct 13, 2023

Changes in this version

type ClientOption

+ Logger Logger

+ Recovery func(logger Logger)

type Config

+ Logger Logger

+ Recovery func(logger Logger)

+ type Logger interface

+ Error func(v ...any)

type ServerOption

+ Logger Logger

+ Recovery func(logger Logger)

+ TlsConfig *tls.Config

Sep 23, 2023

Changes in this version

type Broadcaster

+ func (c *Broadcaster) Close() error

type Conn

+ func (c *Conn) Session() SessionStorage

Aug 17, 2023

Changes in this version

+ var ErrCompressionNegotiation = errors.New("invalid compression negotiation")

+ var ErrSubprotocolNegotiation = errors.New("sub-protocol negotiation failed")

Aug 5, 2023

Changes in this version

+ var ErrConnClosed = net.ErrClosed

+ var ErrTextEncoding = errors.New("invalid text encoding")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrUnsupportedProtocol = errors.New("unsupported protocol")

type Conn

+ func (c *Conn) SubProtocol() string

type ServerOption

+ SubProtocols []string

Jul 30, 2023

Changes in this version

type ClientOption

+ NewSessionStorage func() SessionStorage

type ServerOption

+ NewSessionStorage func() SessionStorage

Jul 22, 2023

Changes in this version

+ type Broadcaster struct

+ func NewBroadcaster(opcode Opcode, payload []byte) *Broadcaster

+ func (c *Broadcaster) Broadcast(socket *Conn) error

+ func (c *Broadcaster) Release()

type Conn

+ func (c *Conn) SetNoDelay(noDelay bool) error

Jul 14, 2023

Changes in this version

type Server

+ OnRequest func(socket *Conn, request *http.Request)

Jun 12, 2023

Changes in this version

type ClientOption

+ HandshakeTimeout time.Duration

+ NewDialer func() (Dialer, error)

+ type CloseError struct

+ Code uint16

+ Reason []byte

+ func (c *CloseError) Error() string

+ type Dialer interface

+ Dial func(network, addr string) (c net.Conn, err error)

Jun 2, 2023

Changes in this version

type ServerOption

+ HandshakeTimeout time.Duration

May 12, 2023

Changes in this version

+ type Comparable interface

type Config

+ CompressorNum int

type Conn

+ func NewClientFromConn(handler Event, option *ClientOption, conn net.Conn) (client *Conn, resp *http.Response, e error)

type ServerOption

+ Authorize func(r *http.Request, session SessionStorage) bool

+ CompressorNum int

May 5, 2023

Changes in this version

+ var JsonCodec = new(jsonCodec)

+ type Codec interface

+ NewEncoder func(io.Writer) Encoder

type Conn

+ func (c *Conn) WriteAny(codec Codec, opcode Opcode, v interface{}) error

+ type Encoder interface

+ Encode func(v interface{}) error

May 2, 2023

Changes in this version

type Server

+ func (c *Server) RunListener(listener net.Listener) error

Apr 28, 2023

Changes in this version

type Conn

+ func (c *Conn) ReadLoop()

type Server

+ OnConnect func(conn net.Conn) error

Apr 27, 2023

Changes in this version

+ type Server struct

+ OnError func(conn net.Conn, err error)

+ func NewServer(eventHandler Event, option *ServerOption) *Server

+ func (c *Server) Run(addr string) error

+ func (c *Server) RunTLS(addr string, certFile, keyFile string) error

Mar 7, 2023

Changes in this version

type ServerOption

+ Subprotocols []string

Mar 6, 2023

Changes in this version

+ type ClientOption struct

+ Addr string

+ CheckUtf8Enabled bool

+ CompressEnabled bool

+ CompressLevel int

+ CompressThreshold int

+ DialTimeout time.Duration

+ ReadAsyncCap int

+ ReadAsyncEnabled bool

+ ReadAsyncGoLimit int

+ ReadBufferSize int

+ ReadMaxPayloadSize int

+ RequestHeader http.Header

+ TlsConfig *tls.Config

+ WriteAsyncCap int

+ WriteBufferSize int

+ WriteMaxPayloadSize int

type Conn

+ func NewClient(handler Event, option *ClientOption) (client *Conn, resp *http.Response, e error)

Mar 3, 2023

Changes in this version

type Config

+ CheckUtf8Enabled bool

+ CompressThreshold int

+ ReadAsyncCap int

+ ReadAsyncEnabled bool

+ ReadAsyncGoLimit int

+ ReadBufferSize int

+ ReadMaxPayloadSize int

+ WriteAsyncCap int

+ WriteBufferSize int

+ WriteMaxPayloadSize int

+ type ServerOption struct

+ CheckOrigin func(r *http.Request, session SessionStorage) bool

+ CheckUtf8Enabled bool

+ CompressEnabled bool

+ CompressLevel int

+ CompressThreshold int

+ ReadAsyncCap int

+ ReadAsyncEnabled bool

+ ReadAsyncGoLimit int

+ ReadBufferSize int

+ ReadMaxPayloadSize int

+ ResponseHeader http.Header

+ WriteAsyncCap int

+ WriteBufferSize int

+ WriteMaxPayloadSize int

Feb 28, 2023

Changes in this version

type Option

+ func WithAsyncReadGoLimit(limit int) Option

+ func WithAsyncWriteCap(capacity int) Option

type Upgrader

+ AsyncReadGoLimit int

+ AsyncWriteCap int

Feb 25, 2023

Changes in this version

+ type BuiltinEventHandler struct

+ func (b BuiltinEventHandler) OnClose(socket *Conn, code uint16, reason []byte)

+ func (b BuiltinEventHandler) OnError(socket *Conn, err error)

+ func (b BuiltinEventHandler) OnMessage(socket *Conn, message *Message)

+ func (b BuiltinEventHandler) OnOpen(socket *Conn)

+ func (b BuiltinEventHandler) OnPing(socket *Conn, payload []byte)

+ func (b BuiltinEventHandler) OnPong(socket *Conn, payload []byte)

type Conn

+ func (c *Conn) WriteAsync(opcode Opcode, payload []byte)

type Option

+ func WithAsyncIOGoLimit(limit int) Option

+ func WithAsyncReadEnabled() Option

type Upgrader

+ AsyncIOGoLimit int

+ AsyncReadEnabled bool

Feb 17, 2023

Changes in this version

type Upgrader

+ CompressionThreshold int

Feb 6, 2023

Changes in this version

type Message

+ Data *bytes.Buffer

+ Opcode Opcode

Feb 3, 2023

Changes in this version

+ type BuiltinEventEngine struct

+ func (b BuiltinEventEngine) OnClose(socket *Conn, code uint16, reason []byte)

+ func (b BuiltinEventEngine) OnError(socket *Conn, err error)

+ func (b BuiltinEventEngine) OnMessage(socket *Conn, message *Message)

+ func (b BuiltinEventEngine) OnOpen(socket *Conn)

+ func (b BuiltinEventEngine) OnPing(socket *Conn, payload []byte)

+ func (b BuiltinEventEngine) OnPong(socket *Conn, payload []byte)

type Upgrader

+ func (c *Upgrader) Initialize()

Jan 15, 2023

Changes in this version

+ type Option func(c *Upgrader)

+ func WithCheckOrigin(f func(r *Request) bool) Option

+ func WithCheckTextEncoding(check bool) Option

+ func WithCompress(enabled bool, level int) Option

+ func WithEventHandler(eventHandler Event) Option

+ func WithInitialize() Option

+ func WithMaxContentLength(n int) Option

+ func WithResponseHeader(h http.Header) Option

type Upgrader

+ CheckTextEncoding bool

+ EventHandler Event

+ ResponseHeader http.Header

+ func NewUpgrader(options ...Option) *Upgrader

+ func (c *Upgrader) Accept(w http.ResponseWriter, r *http.Request) (*Conn, error)

Jan 13, 2023

Changes in this version

type Conn

+ func (c *Conn) NetConn() net.Conn

+ func (c *Conn) WriteString(s string)

Jan 13, 2023

Changes in this version

type Conn

+ func (c *Conn) WriteBinary(payload []byte)

+ func (c *Conn) WriteText(payload string)

Jan 9, 2023

Changes in this version

+ type ConcurrentMap struct

+ func NewConcurrentMap(segments uint64) *ConcurrentMap

+ func (c *ConcurrentMap) Delete(key interface{})

+ func (c *ConcurrentMap) Len() int

+ func (c *ConcurrentMap) Load(key interface{}) (value interface{}, exist bool)

+ func (c *ConcurrentMap) Range(f func(key interface{}, value interface{}) bool)

+ func (c *ConcurrentMap) Store(key interface{}, value interface{})

Jan 8, 2023

Changes in this version

type Config

+ CheckOrigin func(r *Request) bool

+ ResponseHeader http.Header

Jan 7, 2023

Changes in this version

+ type Map struct

+ func NewMap() *Map

+ func (c *Map) Delete(key interface{})

+ func (c *Map) Len() int

+ func (c *Map) Load(key interface{}) (value interface{}, exist bool)

+ func (c *Map) Range(f func(key, value interface{}) bool)

+ func (c *Map) Store(key interface{}, value interface{})

+ type SessionStorage interface

+ Delete func(key interface{})

+ Load func(key interface{}) (value interface{}, exist bool)

+ Range func(f func(key, value interface{}) bool)

+ Store func(key interface{}, value interface{})

Jan 7, 2023

Changes in this version

type Conn

+ SessionStorage *sync.Map

type Request

+ SessionStorage *sync.Map

Jan 6, 2023

Changes in this version

+ type Config struct

+ Authenticate func(r *internal.Request) bool

+ CheckTextEncoding bool

+ CompressEnabled bool

+ CompressLevel int

+ MaxContentLength int

type Conn

+ func Accept(ctx context.Context, w http.ResponseWriter, r *http.Request, ...) (*Conn, error)

Jan 4, 2023

Changes in this version

type Conn

+ func (c *Conn) Listen()

+ func (c *Conn) SetReadDeadline(t time.Time)

+ func (c *Conn) SetWriteDeadline(t time.Time)

+ type Event interface

+ OnClose func(socket *Conn, message *Message)

+ OnError func(socket *Conn, err error)

+ OnMessage func(socket *Conn, message *Message)

+ OnOpen func(socket *Conn)

+ OnPing func(socket *Conn, message *Message)

+ OnPong func(socket *Conn, message *Message)

type Message

+ func (c *Message) Code() CloseCode

type Opcode

+ func (c Opcode) IsDataFrame() bool

+ type Storage = internal.Map

Jan 2, 2023

Changes in this version

+ const DefaultCompressLevel

+ const DefaultHandshakeTimeout

+ const DefaultMaxContentLength

+ const DefaultMessageChannelBufferSize

+ const DefaultReadTimeout

+ const DefaultWriteTimeout

+ var ErrCheckOrigin = errors.New("check origin error")

+ var ErrHandshake = errors.New("handshake error")

+ type CloseCode uint16

+ func (c CloseCode) Bytes() []byte

+ func (c CloseCode) Error() string

+ func (c CloseCode) Uint16() uint16

type Conn

+ func (c *Conn) FlushWriter()

+ func (c *Conn) ReadMessage() <-chan *Message

+ func (c *Conn) WriteBatch(messageType Opcode, content []byte)

+ func (c *Conn) WriteMessage(messageType Opcode, content []byte)

type Message

+ func (c *Message) Err() error

+ func (c *Message) Read(p []byte) (n int, err error)

+ func (c *Message) Typ() Opcode

type Upgrader

+ CompressEnabled bool

+ CompressLevel int

+ HandshakeTimeout time.Duration

+ MaxContentLength int

+ MessageChannelBufferSize int

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

Sep 18, 2022

Changes in this version

type Conn

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) RemoteAddr() net.Addr

type HandlerFunc

+ func RateLimiter(d time.Duration, n int64) HandlerFunc

+ func Recovery(exceptionHandler func(exception interface{})) HandlerFunc

Sep 13, 2022

Changes in this version

+ var ERR_CheckOrigin = errors.New("check origin error")

+ var ERR_WebSocketHandshake = errors.New("websocket handshake error")

+ type Code uint16

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerErr

+ const CloseMessageTooLarge

+ const CloseMissingExtension

+ const CloseNoStatusReceived

+ const CloseNormalClosure

+ const ClosePolicyViolation

+ const CloseProtocolError

+ const CloseServiceRestart

+ const CloseTLSHandshake

+ const CloseTryAgainLater

+ const CloseUnsupported

+ const CloseUnsupportedData

+ func (c Code) Bytes() []byte

+ func (c Code) Error() string

+ func (c Code) Uint16() uint16

+ type Conn struct

+ Storage *internal.Map

+ func (c *Conn) Close(code Code, reason []byte) (err error)

+ func (c *Conn) Context() context.Context

+ func (c *Conn) SetDeadline(d time.Duration) error

+ func (c *Conn) Write(messageType Opcode, content []byte)

+ func (c *Conn) WriteClose(code Code, reason []byte)

+ func (c *Conn) WritePing(payload []byte)

+ func (c *Conn) WritePong(payload []byte)

+ type EventHandler interface

+ OnClose func(socket *Conn, code Code, reason []byte)

+ OnError func(socket *Conn, err error)

+ OnMessage func(socket *Conn, m *Message)

+ OnOpen func(socket *Conn)

+ OnPing func(socket *Conn, m []byte)

+ OnPong func(socket *Conn, m []byte)

+ OnRecover func(socket *Conn, exception interface{})

+ type HandlerFunc func(socket *Conn, msg *Message)

+ type Message struct

+ func NewMessage(messageType Opcode, data []byte) *Message

+ func (c *Message) Abort(socket *Conn)

+ func (c *Message) Bytes() []byte

+ func (c *Message) Close()

+ func (c *Message) MessageType() Opcode

+ func (c *Message) Next(socket *Conn)

+ type Opcode uint8

+ const OpcodeBinary

+ const OpcodeCloseConnection

+ const OpcodeContinuation

+ const OpcodePing

+ const OpcodePong

+ const OpcodeText

+ type Request struct

+ Storage *internal.Map

+ type ServerOptions struct

+ CompressEnabled bool

+ CompressLevel int

+ Concurrency uint8

+ HandshakeTimeout time.Duration

+ LogEnabled bool

+ MaxContentLength int

+ ReadBufferSize int

+ ReadTimeout time.Duration

+ WriteBufferSize int

+ WriteTimeout time.Duration

+ type Upgrader struct

+ CheckOrigin func(r *Request) bool

+ Header http.Header

+ func (c *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, handler EventHandler) error

+ func (c *Upgrader) Use(handlers ...HandlerFunc)