websocket

package
v0.21.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsErrorCloseNormal

func IsErrorCloseNormal(err error) bool

IsErrorCloseNormal returns true if it the error received contains a 1000 as its code, as specified by in RFC 6455, section 11.7 for a normal close message.

func IsUnexpectedCloseError

func IsUnexpectedCloseError(err error) bool

Types

type Conn

type Conn interface {
	Close() error
	LocalAddr() net.Addr
	RemoteAddr() net.Addr
	UnderlyingConn() net.Conn

	Subprotocol() string

	NextWriter(messageType int) (io.WriteCloser, error)
	WriteMessage(messageType int, data []byte) error
	WriteControl(messageType int, data []byte, deadline time.Time) error
	WritePreparedMessage(pm *websocket.PreparedMessage) error
	SetWriteDeadline(t time.Time) error
	EnableWriteCompression(enable bool)
	SetCompressionLevel(level int) error

	NextReader() (messageType int, r io.Reader, err error)
	ReadMessage() (messageType int, p []byte, err error)
	SetReadDeadline(t time.Time) error
	SetReadLimit(limit int64)

	SetCloseHandler(h func(code int, text string) error)
	CloseHandler() func(code int, text string) error
	SetPingHandler(h func(appData string) error)
	PingHandler() func(appData string) error
	SetPongHandler(h func(appData string) error)
	PongHandler() func(appData string) error

	ReadJSON(any) error
}

Conn represents a WebSocket connection.

type GorillaUpgrader

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

GorillaUpgrader implements Upgrader using Gorilla's WebSocket implementation.

func (*GorillaUpgrader) Upgrade

func (u *GorillaUpgrader) Upgrade(res http.ResponseWriter, req *http.Request) (Conn, error)

type Upgrader

type Upgrader interface {
	Upgrade(res http.ResponseWriter, req *http.Request) (Conn, error)
}

Upgrader should be implemented by structures that want to be able to convert an HTTP request into WebSocket connection.

func NewGorillaWebSocketUpgrader

func NewGorillaWebSocketUpgrader() Upgrader

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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