zsocket

package module

Go to main page

Versions in this module

v1

v1.0.1

Aug 7, 2026

Changes in this version

+ var DefaultDialer = &Dialer

+ var DefaultUpgrader = Upgrader

+ var ErrBadHandshake = errors.New("zsocket: bad handshake")

+ var ErrCloseSent = errors.New("zsocket: close sent")

+ var ErrReadLimit = errors.New("zsocket: read limit exceeded")

+ func FormatCloseMessage(code CloseCode, text string) []byte

+ func IsCloseError(err error, codes ...CloseCode) bool

+ func IsSameOrigin(r *http.Request) bool

+ func IsUnexpectedCloseError(err error, expectedCodes ...CloseCode) bool

+ func IsWebSocketUpgrade(r *http.Request) bool

+ func JoinMessages(c *Conn, term string) io.Reader

+ func Subprotocols(r *http.Request) []string

+ type BufferPool interface

+ Get func() any

+ Put func(any)

+ func NewBufferPool(size int) BufferPool

type CloseCode

+ const CloseNoStatusReceived

+ const CloseTLSHandshake

type CloseError

+ Text string

+ type CloseHandler func(code CloseCode, text string) error

+ type Compressor interface

+ Compress func(data []byte) ([]byte, error)

+ Decompress func(data []byte) ([]byte, error)

type Config

+ CompressionLevel int

+ EnableCompression bool

+ WriteBufferPool BufferPool

type Conn

+ func Dial(urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

+ func (c *Conn) CloseHandler() CloseHandler

+ func (c *Conn) EnableSendQueue(size int)

+ func (c *Conn) EnableWriteCompression(enable bool)

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

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

+ func (c *Conn) NextReader() (MessageType, io.Reader, error)

+ func (c *Conn) NextWriter(mt MessageType) (io.WriteCloser, error)

+ func (c *Conn) PingHandler() PingHandler

+ func (c *Conn) PongHandler() PongHandler

+ func (c *Conn) ReadMessage() (MessageType, []byte, error)

+ func (c *Conn) Send(ctx context.Context, mt MessageType, data []byte) error

+ func (c *Conn) SetCloseHandler(h CloseHandler)

+ func (c *Conn) SetCompressionLevel(level int) error

+ func (c *Conn) SetPingHandler(h PingHandler)

+ func (c *Conn) SetPongHandler(h PongHandler)

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

+ func (c *Conn) SetReadLimit(limit int64)

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

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

+ func (c *Conn) WriteMessage(mt MessageType, data []byte) error

+ func (c *Conn) WritePreparedMessage(pm *PreparedMessage) error

+ type Deflate struct

+ func NewDeflate(level int) (*Deflate, error)

+ func (d *Deflate) Compress(data []byte) ([]byte, error)

+ func (d *Deflate) Decompress(data []byte) ([]byte, error)

+ type Dialer struct

+ EnableCompression bool

+ HandshakeTimeout time.Duration

+ Jar http.CookieJar

+ NetDial func(network, addr string) (net.Conn, error)

+ NetDialContext func(ctx context.Context, network, addr string) (net.Conn, error)

+ NetDialTLSContext func(ctx context.Context, network, addr string) (net.Conn, error)

+ Proxy func(*http.Request) (*url.URL, error)

+ ReadBufferSize int

+ Subprotocols []string

+ TLSClientConfig *tls.Config

+ WriteBufferSize int

+ func (d *Dialer) Dial(urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

+ func (d *Dialer) DialContext(ctx context.Context, urlStr string, requestHeader http.Header) (*Conn, *http.Response, error)

type Hub

+ func (h *Hub) BroadcastNonBlocking(room string, mt MessageType, msg []byte)

type MessageType

+ const CloseMessage

+ const PingMessage

+ const PongMessage

+ type PingHandler func(appData string) error

+ type PongHandler func(appData string) error

+ type PreparedMessage struct

+ func NewPreparedMessage(mt MessageType, data []byte) (*PreparedMessage, error)

+ type Upgrader struct

+ Config Config

+ func (u Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*Conn, error)

v1.0.0

Aug 23, 2025

Changes in this version

+ var ErrBadRequest = errors.New("zsocket: bad websocket upgrade request")

+ var ErrClosed = errors.New("zsocket: connection closed")

+ var ErrHandshakeFailed = errors.New("zsocket: handshake failed")

+ var ErrOriginNotAllowed = errors.New("zsocket: origin not allowed")

+ var ErrSubprotocolRejected = errors.New("zsocket: subprotocol rejected")

+ var ErrTimeout = errors.New("zsocket: timeout")

+ type CloseCode uint16

+ const CloseAbnormalClosure

+ const CloseGoingAway

+ const CloseInternalServerErr

+ const CloseInvalidFramePayloadData

+ const CloseMandatoryExtension

+ const CloseMessageTooBig

+ const CloseNoStatusRcvd

+ const CloseNormalClosure

+ const ClosePolicyViolation

+ const CloseProtocolError

+ const CloseUnsupportedData

+ type CloseError struct

+ Code CloseCode

+ Reason string

+ func (e CloseError) Error() string

+ type Config struct

+ AllowedOrigins []string

+ CheckOrigin func(origin string) bool

+ HandshakeTimeout time.Duration

+ Logger Logger

+ PingInterval time.Duration

+ PongWait time.Duration

+ ReadBufferSize int

+ ReadLimit int64

+ Subprotocols []string

+ WriteBufferSize int

+ WriteTimeout time.Duration

+ func DefaultConfig() Config

+ type Conn struct

+ func Accept(w http.ResponseWriter, r *http.Request, cfg Config) (*Conn, error)

+ func (c *Conn) Close(code CloseCode, reason string) error

+ func (c *Conn) Read(ctx context.Context) (MessageType, []byte, error)

+ func (c *Conn) ReadJSON(ctx context.Context, v any) error

+ func (c *Conn) RemoteAddr() string

+ func (c *Conn) Subprotocol() string

+ func (c *Conn) Write(ctx context.Context, mt MessageType, data []byte) error

+ func (c *Conn) WriteControl(opcode byte, payload []byte) error

+ func (c *Conn) WriteJSON(ctx context.Context, v any) error

+ type Hub struct

+ func NewHub() *Hub

+ func (h *Hub) Broadcast(ctx context.Context, room string, mt MessageType, msg []byte)

+ func (h *Hub) Join(room string, c *Conn)

+ func (h *Hub) Leave(room string, c *Conn)

+ func (h *Hub) LeaveAll(c *Conn)

+ type Logger interface

+ Debugf func(format string, args ...any)

+ Errorf func(format string, args ...any)

+ Infof func(format string, args ...any)

+ Warnf func(format string, args ...any)

+ type MessageType byte

+ const BinaryMessage

+ const TextMessage

+ type NopLogger struct

+ func (NopLogger) Debugf(string, ...any)

+ func (NopLogger) Errorf(string, ...any)

+ func (NopLogger) Infof(string, ...any)

+ func (NopLogger) Warnf(string, ...any)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL