Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

websocket

package

Go to main page

Versions in this module

v0

v0.0.14

May 11, 2026

v0.0.13

Apr 23, 2026

Changes in this version

type Event

+ func NewEvent(Type string, payload json.RawMessage) *Event

type Timestamp

+ Nano int32

+ func NewTimestamp() *Timestamp

v0.0.12

Apr 23, 2026

v0.0.11

Apr 23, 2026

v0.0.10

Apr 23, 2026

Changes in this version

type Handler

+ OnClientConnection emitter.Emitter[*Client]

+ OnClientDisconnection emitter.Emitter[*Client]

v0.0.9

Apr 23, 2026

Changes in this version

+ const AnyOrigin

+ const ClientEventBufferSizeDefault

+ const ClientEventBufferSizeFieldName

+ const OriginsFieldName

+ const PingTimeoutDefault

+ const PingTimeoutFieldName

+ const ReadBufferSizeDefault

+ const ReadBufferSizeFieldName

+ const WriteBufferSizeDefault

+ const WriteBufferSizeFieldName

+ const WriteTimeoutDefault

+ const WriteTimeoutFieldName

+ var Component = &component.Component

+ var MessageChanClosedError = errors.New("message channel is closed")

+ var MessageChanFullError = errors.New("message channel is full")

+ type Client struct

+ func NewClient(conn *websocket.Conn, config *Config, onMessage emitter.Emitter[*Event], ...) *Client

+ func (c *Client) Process(ctx context.Context) error

+ func (c *Client) Send(event *Event) error

+ type Config struct

+ ClientEventBufferSize int

+ Origins set.Set[string]

+ PingInterval time.Duration

+ PingTimeout time.Duration

+ ReadBufferSize int

+ WriteBufferSize int

+ WriteTimeout time.Duration

+ func Configuration(config *Config, configurator configurator.Configurator) *Config

+ func NewConfig() *Config

+ type Event struct

+ Payload json.RawMessage

+ Timestamp *Timestamp

+ Type string

+ type Handler struct

+ OnMessage emitter.Emitter[*Event]

+ func NewHandler(config *Config, upgrader *Upgrader, logger logger.Logger, closer closer.Closer) *Handler

+ func (h *Handler) Send(event *Event) (err error)

+ func (h *Handler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

+ type Timestamp struct

+ Nanos int64

+ Seconds int64

+ type Upgrader struct

+ func NewUpgrader(config *Config) *Upgrader

+ func (up *Upgrader) CheckOrigin(r *http.Request) bool