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
- API
  
  Reference documentation for the pkg.go.dev API
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

ws

package

Go to main page

Versions in this module

v1

v1.4.1

Jul 26, 2026

Changes in this version

type Handler

+ func (h *Handler) SetMetrics(m Metrics)

type Hub

+ func (h *Hub) SetMetrics(m Metrics)

+ type Metrics interface

+ SetWSActive func(n int)

+ WSConnected func()

+ WSDisconnected func(reason string)

+ WSDrained func(count int)

+ WSHandshakeRejected func(reason string)

+ WSSendFailure func()

v1.1.0

Jul 21, 2026

Changes in this version

+ const ReasonPingTimeout

+ const ReasonReplaced

+ const ReasonShuttingDown

+ const StatusReplaced

+ func BuildNotification(msg *identity.Message) []byte

+ func NotificationForMessage(ctx context.Context, store HandlerStore, msg *identity.Message) []byte

+ type Handler struct

+ func NewHandler(hub *Hub, store HandlerStore) *Handler

+ func (h *Handler) ServeWithEmail(w http.ResponseWriter, r *http.Request, rawEmail string)

+ type HandlerStore interface

+ GetAgentByEmail func(ctx context.Context, email string) (*identity.AgentIdentity, error)

+ GetMessagesByAgent func(ctx context.Context, f identity.MessageListFilter) ([]identity.Message, error)

+ GetPrincipalByAPIKey func(ctx context.Context, apiKey string) (*identity.Principal, error)

+ type Hub struct

+ func NewHub() *Hub

+ func (h *Hub) Close()

+ func (h *Hub) IsConnected(agentID string) bool

+ func (h *Hub) Register(agentID string, conn *websocket.Conn) (old *websocket.Conn)

+ func (h *Hub) Send(agentID string, msg []byte) bool

+ func (h *Hub) Unregister(agentID string, conn *websocket.Conn)